Skip to main content

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}
826
827impl Stack {
828    /// The layout given, with the three fields only the lowering knows the answer to filled in.
829    ///
830    /// Everything else in a layout comes from the flags the function is compiled under or from the
831    /// allocation, so this takes one and returns it rather than building one.
832    ///
833    /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
834    /// zone, which is the words below the stack pointer nothing else may write, and a function
835    /// control comes back into from a `__builtin_longjmp` has already had something else running
836    /// down there: whatever it called and whatever that called, or a signal handler on the same
837    /// stack. Every one of those has written over the red zone by the time control arrives, so a
838    /// value this function left there would not be there any more.
839    #[must_use]
840    pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
841        Layout {
842            leaf: self.calls.is_none() && !self.saves_place,
843            outgoing: self.calls.unwrap_or(0),
844            locals: &self.locals,
845            grows: self.grown_at.is_some(),
846            ..base
847        }
848    }
849}
850
851/// The machine IR for that function, for the machine the selector describes.
852///
853/// # Errors
854///
855/// The first instruction no rule fires on, which today is anything at a width the rule set is not
856/// written at, a parameter that does not arrive in a register this can read, or a call that
857/// passes something this cannot put where the convention wants it.
858pub fn func(
859    source: &Func,
860    names: &mut Interner,
861    selector: &'static Selector,
862    conv: &'static CallRegs,
863    elsewhere: &Elsewhere,
864) -> Result<Lowered, Unsupported> {
865    func_for(source, names, selector, conv, elsewhere, true)
866}
867
868/// [`func`], for a build that says whether it writes debugging information. Without it the walk
869/// leaves out which value each declaration holds on the way into each block, since that is read
870/// only for the debugging information.
871///
872/// # Errors
873///
874/// The same as [`func`].
875pub fn func_for(
876    source: &Func,
877    names: &mut Interner,
878    selector: &'static Selector,
879    conv: &'static CallRegs,
880    elsewhere: &Elsewhere,
881    debug: bool,
882) -> Result<Lowered, Unsupported> {
883    Lowering::new(source, names, selector, conv, elsewhere, debug).run()
884}
885
886/// What the matcher settled on for one block, indexed the way the block's instructions are.
887struct Decided {
888    /// What each instruction matched, and nothing for one that matched no rule or was folded
889    /// into a later one.
890    found: Vec<Option<Match<Term>>>,
891    /// How each instruction showed its operands to the matcher, which is what says what it took.
892    plans: Vec<Option<Plan>>,
893    /// The instructions some other instruction took, which are the ones with nothing to write.
894    folded: Vec<Inst>,
895}
896
897/// The instruction in front of an assignment that starts a declaration on a value, and the first
898/// machine instruction after it once the block is filled.
899type Mark = (Option<Inst>, Option<mir::Inst>);
900
901/// One function being lowered.
902struct Lowering<'a> {
903    source: &'a Func,
904    names: &'a mut Interner,
905    out: mir::Func,
906    /// The machine register each IR value is in, once it has one.
907    regs: Vec<Option<mir::Reg>>,
908    /// For a constant that has been written into a register, the block it was written into,
909    /// which is the only block that register is any good in.
910    written: Vec<Option<mir::Block>>,
911    /// How many times each IR value is read, which is what says whether an instruction may be
912    /// folded into the one that reads it.
913    uses: Vec<u32>,
914    /// The block being filled.
915    at: Option<mir::Block>,
916    /// The machine IR block each IR block became.
917    blocks: Vec<Option<mir::Block>>,
918    /// The class an address is in, which is the general purpose one and is not a question: every
919    /// register an addressing mode names holds part of an address, and there is no machine here
920    /// that computes an address anywhere but in this file. Which class a *value* is in is
921    /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
922    gpr: RegClass,
923    /// The machine this selects for.
924    selector: &'static Selector,
925    /// Where the convention this function is compiled for puts things, which is read for the
926    /// arguments and for the calls.
927    conv: &'static CallRegs,
928    /// Which names this function may not work an address out for itself, which is a fact about the
929    /// module and so is worked out before any of this and handed in.
930    elsewhere: &'a Elsewhere,
931    /// Whether the build writes debugging information, which is the one thing that reads which
932    /// value a declaration holds on the way into each block.
933    debug: bool,
934    /// What the function wants its stack to look like, filled in as the walk finds out.
935    stack: Stack,
936    /// What a `va_start` in this function has to write, or nothing for a function that takes no
937    /// arguments its signature does not name.
938    ///
939    /// Worked out once, when the entry block binds the parameters, because every number in it is
940    /// about where those parameters left the walk over the argument registers and there is nowhere
941    /// else that knows.
942    varargs: Option<Varargs>,
943    /// Which of the function's stack objects each eighty bit value lives in, once it has asked
944    /// for one.
945    ///
946    /// One slot per value and it is never given back, which is what makes an eighty bit value
947    /// behave like every other one: it is written once and read wherever it is read, and no two
948    /// of them share a slot the way two of them would share a register. What is in a register is
949    /// the address, and that is worked out again at every use rather than kept, so nothing here
950    /// holds a general purpose register open across a whole function.
951    slots: Vec<Option<usize>>,
952    /// The eight bytes a value passes through between a register and the x87 stack, once
953    /// something has wanted them.
954    ///
955    /// One for the whole function, because every group that uses it is a handful of instructions
956    /// with nothing in between: the bytes are written, read straight back and never looked at
957    /// again, so a second slot would be a second slot holding the same nothing.
958    crossing: Option<usize>,
959    /// The four bytes the control word is saved in and the changed copy written to, once
960    /// something has wanted them.
961    ///
962    /// One for the whole function for the reason above, and four rather than two because it is
963    /// two words: the one the unit had and the one with the rounding field turned to truncate.
964    control: Option<usize>,
965    /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
966    ///
967    /// One for the whole function however many saves there are in it, because the word is written
968    /// and read back with nothing in between: the save writes a zero into it and the instruction
969    /// straight after reads it, and the only other thing that ever writes it is a restore arriving
970    /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
971    /// inside the other.
972    answer: Option<usize>,
973    /// The block `__builtin_apply_args` answers the address of, or nothing in a function that holds
974    /// none.
975    ///
976    /// Written once, in the prologue, because what it holds is every argument register as it was
977    /// on the way in, and by the time the walk reaches the call the registers hold whatever the
978    /// function has done since. Every `__builtin_apply_args` in the function answers the same one.
979    applied: Option<usize>,
980    /// Which rules have fired so far.
981    fired: Fired,
982    /// Where each assignment that starts a declaration on a value part of the way through is, by
983    /// the IR block it is in and the instruction in front of it, and which machine instruction
984    /// is the first one after it once the block has been filled. See
985    /// [`rucc_ir::Func::declare_value_from`].
986    marks: HashMap<Block, Vec<Mark>>,
987    /// The frame slot each fixed size `alloca` was given, which a landing pad writes the address
988    /// of again rather than reading the register the rest of the function has it in. See
989    /// [`Self::pad`].
990    frame_slots: HashMap<Value, usize>,
991    /// The machine call each IR call with an unwind edge became, which [`Self::edges`] pairs with
992    /// the pad the edge went to. See [`rucc_ir::Opcode::Unwound`].
993    unwinding: HashMap<Inst, mir::Inst>,
994}
995
996/// What a `va_start` in a variadic function writes into the list it is given.
997///
998/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
999/// both are written down. Neither is a set of numbers on its own: where the save area is and where
1000/// the caller's argument area is are distances into a frame that does not exist until after
1001/// allocation, so each is a `lea` [`crate::finish`] fills in.
1002#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1003enum Varargs {
1004    /// The four field list, whose two offsets are settled here and whose two addresses are not.
1005    Fields {
1006        /// Which of the function's stack objects is the register save area.
1007        save: usize,
1008        /// How far up the caller's argument area the first argument the signature does not name is,
1009        /// which is the whole of that area the named ones did not take.
1010        incoming: u32,
1011        /// What `gp_offset` starts at, which is past the general purpose registers the named
1012        /// arguments took.
1013        integers: u32,
1014        /// What `fp_offset` starts at, which is past the vector ones.
1015        floats: u32,
1016    },
1017    /// The AAPCS64 list, whose two offsets count up to zero from the top of each half of the save
1018    /// area. The two tops are addresses in the frame and so is the first field, like the SysV list.
1019    Aapcs {
1020        /// Which of the function's stack objects is the register save area.
1021        save: usize,
1022        /// How far up the caller's argument area the first argument the signature does not name is.
1023        incoming: u32,
1024        /// Where the general purpose half of the save area ends.
1025        integers_end: u32,
1026        /// Where the vector half ends, which is the end of the area.
1027        floats_end: u32,
1028        /// What `__gr_offs` starts at, which is minus the general purpose half the named arguments
1029        /// did not take.
1030        integers: i32,
1031        /// What `__vr_offs` starts at.
1032        floats: i32,
1033    },
1034    /// The list that is a pointer, which is the one address and nothing else.
1035    Pointer {
1036        /// How far up the caller's argument area the first argument the signature does not name is,
1037        /// which on this convention is the word belonging to the position the named ones stopped
1038        /// at.
1039        incoming: u32,
1040    },
1041}
1042
1043/// How far a function's name reaches, narrowed from the linkage the IR gave it.
1044///
1045/// The IR has five and an object file says three, and the two the linker cannot tell apart are
1046/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
1047/// no way to record. A function is never `Common`, since that is what a tentative definition of an
1048/// object is and there is no tentative definition of a function, and it is written here rather
1049/// than left out so that a linkage added later has to come past this.
1050const fn binding(linkage: Linkage) -> mir::Binding {
1051    match linkage {
1052        Linkage::Internal => mir::Binding::Local,
1053        Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
1054        Linkage::External | Linkage::Common => mir::Binding::Global,
1055    }
1056}
1057
1058/// How far a function's name reaches outside a shared library, carried across unchanged.
1059///
1060/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
1061/// three of these and the two enumerations are the same three answers written twice: once in a
1062/// crate that is not allowed to know what an object file is and once in one that is.
1063const fn visibility(visibility: Visibility) -> mir::Visibility {
1064    match visibility {
1065        Visibility::Default => mir::Visibility::Default,
1066        Visibility::Hidden => mir::Visibility::Hidden,
1067        Visibility::Protected => mir::Visibility::Protected,
1068    }
1069}
1070
1071impl<'a> Lowering<'a> {
1072    fn new(
1073        source: &'a Func,
1074        names: &'a mut Interner,
1075        selector: &'static Selector,
1076        conv: &'static CallRegs,
1077        elsewhere: &'a Elsewhere,
1078        debug: bool,
1079    ) -> Self {
1080        let counts = source.counts();
1081        let name = source.name;
1082        let mut uses = vec![0; counts.values];
1083        for block in source.blocks() {
1084            for inst in source.insts(block) {
1085                for &arg in &source[source[inst].args] {
1086                    uses[arg.index()] += 1;
1087                }
1088                for call in source.successors(inst) {
1089                    for &arg in &source[call.args] {
1090                        uses[arg.index()] += 1;
1091                    }
1092                }
1093            }
1094        }
1095        let mut out = mir::Func::new(name);
1096        out.align = source.align;
1097        // Carried rather than worked out here, because where a function was declared is a fact
1098        // about the source and this is a long way past it. What wants it is the line table.
1099        out.declared = source.declared;
1100        out.binding = binding(source.linkage);
1101        out.visibility = visibility(source.visibility);
1102        Self {
1103            source,
1104            names,
1105            out,
1106            regs: vec![None; counts.values],
1107            written: vec![None; counts.values],
1108            blocks: vec![None; counts.blocks],
1109            uses,
1110            at: None,
1111            gpr: selector.gpr,
1112            selector,
1113            conv,
1114            elsewhere,
1115            debug,
1116            stack: Stack::default(),
1117            varargs: None,
1118            slots: vec![None; counts.values],
1119            crossing: None,
1120            control: None,
1121            answer: None,
1122            applied: None,
1123            fired: Fired::new(),
1124            marks: HashMap::new(),
1125            frame_slots: HashMap::new(),
1126            unwinding: HashMap::new(),
1127        }
1128    }
1129
1130    fn run(mut self) -> Result<Lowered, Unsupported> {
1131        for value in self.source.values() {
1132            for start in self.source.value_starts(value) {
1133                let Some((block, after)) = self.source.start_place(start) else { continue };
1134                let marks = self.marks.entry(block).or_default();
1135                if !marks.iter().any(|&(have, _)| have == after) {
1136                    marks.push((after, None));
1137                }
1138            }
1139        }
1140        // Every block before any of them is filled, because a block that jumps forward has to
1141        // name the block it jumps to and a machine IR block is named by a handle rather than by
1142        // the IR block it came from.
1143        for block in self.source.blocks() {
1144            let out = self.out.create_block();
1145            self.blocks[block.index()] = Some(out);
1146        }
1147        for block in self.order() {
1148            self.block(block)?;
1149        }
1150        // And the name each block an image holds the address of was given, which nothing in the
1151        // walk above would ask for: the `lea` a label address is inside the function needs no
1152        // symbol, and the one thing that does is a relocation in another section.
1153        let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
1154        let labels: Vec<(mir::Block, Symbol)> =
1155            named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
1156        self.out.labels = labels;
1157        self.naming();
1158        Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
1159    }
1160
1161    /// Which register each declaration the front end kept in a value ended up in, as far as this
1162    /// walk can say, which is the other half of what [`Lowering::new_reg`] writes down as it goes.
1163    ///
1164    /// Two halves because there are two ways a value gets a register here. Most of them ask for a
1165    /// fresh one and that is where `new_reg` catches them, and the rest are put in a register
1166    /// something else chose: a parameter arrives in whichever one the convention handed it, a block
1167    /// parameter in whichever one the edge agreed on, and a result of a rule that names its own
1168    /// registers in the one the rule named. None of those goes past the mint, so this is the map at
1169    /// the end read off the other side, and the two together are every value a declaration is
1170    /// behind.
1171    ///
1172    /// The map on its own would not do, which is why `new_reg` writes down what it writes down: the
1173    /// entry for a constant is cleared every time the walk leaves the block that wrote it, so a
1174    /// local a constant holds is in the map for one block of the function and nowhere else.
1175    fn naming(&mut self) {
1176        let mut named = std::mem::take(&mut self.out.named);
1177        for value in self.source.values() {
1178            let Some(reg) = self.regs[value.index()] else { continue };
1179            named.extend(self.source.value_decls(value).map(|decl| (decl, reg)));
1180            // A start in a block a pass took out was never reached above, and it says nothing
1181            // rather than something about another place.
1182            for start in self.source.value_starts(value) {
1183                let Some((block, after)) = self.source.start_place(start) else { continue };
1184                let first = self.marks.get(&block).and_then(|marks| {
1185                    marks.iter().find(|&&(have, _)| have == after).and_then(|&(_, at)| at)
1186                });
1187                if let Some(first) = first {
1188                    self.out.starts.push((start.decl, reg, first));
1189                }
1190            }
1191        }
1192        named.sort_unstable();
1193        named.dedup();
1194        self.out.named = named;
1195        self.out.starts.sort_unstable();
1196        self.out.starts.dedup();
1197        // Which of its values a declaration holds on the way into a block, for the blocks where
1198        // two of them are live at once. A block a pass took out says nothing, and neither does a
1199        // value the map above has lost the register of, since that is not the same as having none.
1200        // Only for a build that writes debugging information, since that is all that reads it,
1201        // and on a function of tens of thousands of blocks it is a walk of all of them for every
1202        // local.
1203        let mut entries = Vec::new();
1204        let held = if self.debug { crate::holding::on_entry(self.source) } else { Vec::new() };
1205        for (decl, block, value) in held {
1206            if let (Some(block), Some(reg)) = (self.blocks[block.index()], self.regs[value.index()])
1207            {
1208                entries.push((decl, block, reg));
1209            }
1210        }
1211        entries.sort_unstable();
1212        entries.dedup();
1213        self.out.entries = entries;
1214    }
1215
1216    /// The order the blocks are filled in, which is not the order they are written in.
1217    ///
1218    /// Reverse postorder, because a value is written in a block that dominates every block that
1219    /// reads it and a block in reverse postorder comes before every block it dominates. The order
1220    /// the blocks are written in does not have that property: a block written early can read a
1221    /// value a block below it writes, and reading a value with no register yet mints one, so the
1222    /// register the definition writes later is not the register the read named. Nothing writes the
1223    /// one the read named, and what comes out is a function that loads a stack slot no store ever
1224    /// reached. It is the order this walk goes in rather than the order the blocks come out in,
1225    /// which is what the loop above fixes, so the machine function is still written the way the IR
1226    /// function was.
1227    ///
1228    /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
1229    /// them and nothing they name is read by anything that does, but they still have to be filled,
1230    /// because a machine block with no terminator is not one the passes below can read.
1231    fn order(&self) -> Vec<Block> {
1232        let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
1233        let count = self.blocks.len();
1234        let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
1235        for block in self.source.blocks() {
1236            let Some(term) = self.source.terminator(block) else { continue };
1237            succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
1238        }
1239        // An explicit stack, because the depth of the walk is the number of blocks and a function
1240        // built by a generator has as many of those as it likes.
1241        let mut seen = vec![false; count];
1242        let mut order = Vec::with_capacity(count);
1243        let mut stack = vec![(entry, 0usize)];
1244        seen[entry.index()] = true;
1245        while let Some((block, at)) = stack.pop() {
1246            let Some(&next) = succs[block.index()].get(at) else {
1247                order.push(block);
1248                continue;
1249            };
1250            stack.push((block, at + 1));
1251            if !seen[next.index()] {
1252                seen[next.index()] = true;
1253                stack.push((next, 0));
1254            }
1255        }
1256        order.reverse();
1257        order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
1258        order
1259    }
1260
1261    /// One block: its parameters, then every instruction in it that is not folded into another.
1262    fn block(&mut self, block: Block) -> Result<(), Unsupported> {
1263        let out = self.out_block(block);
1264        self.at = Some(out);
1265        if self.source.entry() == Some(block) {
1266            self.arrive(block, out)?;
1267        } else {
1268            let mut arriving = Vec::new();
1269            for &param in &self.source[block].params {
1270                // A value with no register to arrive in, which the class would not say, since
1271                // `class_of` puts one of these in the general purpose file on purpose and what it
1272                // means by that is that nothing there can hold it. What crosses the edge for one
1273                // of those is the address of where the value already is, so the parameter is a
1274                // pointer here and the bytes it points at are copied below.
1275                let ty = self.source[param].ty;
1276                let reg = self.out.append_param(out, self.class_of(ty));
1277                self.sized(reg, ty);
1278                self.regs[param.index()] = Some(reg);
1279                if on_x87(ty) {
1280                    arriving.push((param, reg));
1281                }
1282            }
1283            self.settle(block, &arriving)?;
1284        }
1285        let kept = self.pad(block)?;
1286
1287        // What each instruction matched, and which instructions were folded into another. The
1288        // decision is made for the whole block before any of it is written, and it is made more
1289        // than once: a value that only some of its readers took has to be put back in a register
1290        // for all of them, and taking it away from those readers changes what they match.
1291        let insts: Vec<Inst> = self.source.insts(block).collect();
1292        let mut refused: HashSet<Value> = HashSet::new();
1293        let mut decided = self.decide(&insts, &refused);
1294        while let Some(value) = self.left_alive(&insts, &decided.plans) {
1295            refused.insert(value);
1296            decided = self.decide(&insts, &refused);
1297        }
1298        let Decided { found, folded, .. } = decided;
1299
1300        // Where each assignment in this block that starts a declaration on a value is, as the
1301        // machine instruction in front of the place its IR instruction left off, or the block
1302        // for one where nothing has been written yet. What comes after it is not known until the
1303        // block is filled, so that is read below.
1304        let wanted: HashSet<Option<Inst>> =
1305            self.marks.get(&block).into_iter().flatten().map(|&(after, _)| after).collect();
1306        let mut reached: Vec<(Option<Inst>, mir::Block, Option<mir::Inst>)> = Vec::new();
1307        for (index, (&inst, matched)) in insts.iter().zip(found).enumerate() {
1308            let before = index.checked_sub(1).map(|index| insts[index]);
1309            if wanted.contains(&before) {
1310                let at = self.at.unwrap_or(out);
1311                reached.push((before, at, self.out.terminator(at)));
1312            }
1313            if folded.contains(&inst) || self.writes_nothing(inst) {
1314                continue;
1315            }
1316            // A call is built from the convention rather than matched, which is why it is the one
1317            // opcode looked at by name here. Through an address it is a different instruction and
1318            // the same convention, so the two arrive at the same place and differ in one line of
1319            // it.
1320            match self.source[inst].opcode {
1321                Opcode::Call | Opcode::CallIndirect => {
1322                    self.called(inst)?;
1323                    continue;
1324                }
1325                // The exception a landing pad was entered with, which the unwinder left in the
1326                // first return register. Built by name for the reason a named register is.
1327                Opcode::Landing => {
1328                    self.landing(inst)?;
1329                    continue;
1330                }
1331                // A call and the return behind it, which is what `crate::tail::mark` made it out
1332                // of, and both are built the way they would have been. What makes it a jump is
1333                // written at the very end, once the epilogue is there to jump from.
1334                Opcode::TailCall => {
1335                    self.tail_called(inst)?;
1336                    continue;
1337                }
1338                // Built from the frame rather than matched, for the same shape of reason a call
1339                // is built from the convention: what a rule replaces a term with is instructions,
1340                // and what an `alloca` needs first is bytes, which the rule language has no way
1341                // to ask for.
1342                Opcode::Alloca => {
1343                    self.reserve(inst)?;
1344                    continue;
1345                }
1346                // Reading the stack pointer and writing it back, which are the two ends of a scope
1347                // holding a variable length array. Built here for the reason an `alloca` is: the
1348                // value is a register the rule language has no way to name, because what it holds
1349                // is not a value the program computed but where the machine's stack had got to.
1350                // The arguments the function was handed, saved in the prologue, and a call made
1351                // out of them. Built here because neither is a value a rule could say anything
1352                // about: the first is a place in the frame and the second is a call, whose
1353                // arguments are a block of registers rather than values.
1354                Opcode::ApplyArgs => {
1355                    self.apply_args(inst)?;
1356                    continue;
1357                }
1358                Opcode::Apply => {
1359                    self.apply(inst)?;
1360                    continue;
1361                }
1362                Opcode::StackSave => {
1363                    self.stack_pointer(inst, false)?;
1364                    continue;
1365                }
1366                Opcode::StackRestore => {
1367                    self.stack_pointer(inst, true)?;
1368                    continue;
1369                }
1370                // The address of a name, built here for the same reason an `alloca` is: what a
1371                // rule replaces a term with is instructions over values, and the operand of this
1372                // one is a symbol, which is a thing the rule language has no way to bind and the
1373                // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
1374                // proof over bitvectors could discharge, because what makes it the right answer
1375                // is the relocation and what the linker does with it.
1376                Opcode::GlobalAddr => {
1377                    self.address_of(inst)?;
1378                    continue;
1379                }
1380                // The address of a label and the branch that reads one, built here for the same
1381                // reason and for one more. The reason is the same: what the first of them names is
1382                // a block, which is not a value a rule pattern can bind, and there is nothing in
1383                // the distance between two places in one function that a proof over bitvectors
1384                // could discharge. The extra one is that the second is a terminator whose arms are
1385                // not two and not fixed, and a rule says what an instruction reads rather than
1386                // where a block goes.
1387                Opcode::BlockAddr => {
1388                    self.block_address(inst)?;
1389                    continue;
1390                }
1391                Opcode::IndirectBr => {
1392                    self.indirect_branch(inst)?;
1393                    continue;
1394                }
1395                // A `switch` that `crate::switch` found dense enough for a table, which is a load
1396                // out of the table and the same jump. Built here for the reasons the jump above
1397                // is, and because what the load reads is a place in this function.
1398                Opcode::Switch => {
1399                    self.jump_table(inst)?;
1400                    continue;
1401                }
1402                // The pair that saves a place in this function and comes back to it. Built here
1403                // for the reason the address of a label is, and for two more. The reason is the
1404                // same: the first of them writes down where control comes back to, which is a
1405                // place in this function and not a value a rule pattern can bind. The extra ones
1406                // are that each of them is a group of instructions over a buffer the program owns
1407                // rather than one instruction, and that the first of them leaves the block it was
1408                // written in and carries on in a new one, which is a thing no rule can do.
1409                Opcode::SetjmpMarker => {
1410                    self.saves_place(inst)?;
1411                    continue;
1412                }
1413                Opcode::LongjmpMarker => {
1414                    self.comes_back(inst)?;
1415                    continue;
1416                }
1417                // Where this thread's own storage starts, built here for a reason of the same
1418                // shape: what it reads is `%fs`, which is not a register the rule language can
1419                // bind and not one a proof over bitvectors could say anything about, because what
1420                // makes the load the right answer is an agreement between the loader and the C
1421                // library rather than any arithmetic.
1422                Opcode::ThreadPointer => {
1423                    self.thread_pointer(inst)?;
1424                    continue;
1425                }
1426                // What a named machine register holds, built here for the reason above written
1427                // about any register rather than about one: which register it is is a string
1428                // beside the instruction, and a rule matches on an opcode and a type and could
1429                // not see it. There is nothing to prove either, since the answer is the register
1430                // and the instruction is the move that reads it.
1431                Opcode::RegisterValue => {
1432                    self.register_value(inst)?;
1433                    continue;
1434                }
1435                // Where a frame is and what it returns to, built here for the same reason and one
1436                // more. The reason is the same: what the walk starts from is the frame pointer,
1437                // which is not a register a rule pattern can bind, and there is nothing in reading
1438                // the link the prologue saved that a proof over bitvectors could discharge. The
1439                // extra one is that how long the walk is comes out of a number beside the
1440                // instruction, so one of these is not one instruction but however many the depth
1441                // says, and a rule replaces a term with a term.
1442                Opcode::FrameAddress | Opcode::ReturnAddress => {
1443                    self.frames(inst)?;
1444                    continue;
1445                }
1446                // Built from the frame for the reason an `alloca` is, and from the convention for
1447                // the reason a call is: three of the four fields it writes are distances that do
1448                // not exist until the frame does, and the fourth is where the walk over the
1449                // argument registers stopped. A function that is not variadic has no such walk to
1450                // report, so it has nothing here and is refused below, which is the right answer
1451                // for a `va_start` in one.
1452                Opcode::VaStart if self.varargs.is_some() => {
1453                    self.va_start(inst)?;
1454                    continue;
1455                }
1456                // A return of more than one value, which is a structure small enough to come
1457                // back in a pair of registers. Built from the convention for the reason a call
1458                // is: which register each half goes in depends on the halves in front of it,
1459                // because the two register files are walked separately, and a pattern over a term
1460                // cannot see them. A return of one value is a term with a name and a rule, and it
1461                // stays one.
1462                //
1463                // A return of none in a function whose answer went through memory is here too,
1464                // and for a different reason: what it gives back is not written in the IR at all.
1465                // The convention says the address the caller handed over comes back, and only the
1466                // signature says this function was handed one.
1467                //
1468                // And a return of one eighty bit value, for a third reason: what a rule would
1469                // write is an instruction leaving the value in a register, and this one is left on
1470                // the x87 stack instead. A rule could not name that stack any more than any other
1471                // rule about this type could.
1472                //
1473                // And a return the convention asks this side to extend, which a rule has no way to
1474                // know about since the signature is what says so and not the value.
1475                Opcode::Return
1476                    if self.source[self.source[inst].args].len() > 1
1477                        || self.sret().is_some()
1478                        || self.gives_back_x87(inst)
1479                        || self.widens_return() =>
1480                {
1481                    let values = self.source[self.source[inst].args].to_vec();
1482                    self.returned(inst, values)?;
1483                    continue;
1484                }
1485                // A cast between a pointer and an integer of the same width, which on this
1486                // machine is every one the front end writes. No instruction at all, so no rule
1487                // could name one.
1488                Opcode::PtrToInt | Opcode::IntToPtr => {
1489                    self.rename(inst)?;
1490                    continue;
1491                }
1492                // A barrier, which is one instruction or none depending on the ordering. Written
1493                // by name because there is nothing about it a rule could be proved against, the
1494                // way there is nothing to prove about the address of a symbol.
1495                Opcode::Fence => {
1496                    self.barrier(inst)?;
1497                    continue;
1498                }
1499                // An ordered load or store that `crate::expand::orderings` left alone, which on a
1500                // machine that is not total store order is every one stronger than relaxed. Written
1501                // by name for the barrier's reason: what it adds to the plain access is an ordering.
1502                Opcode::AtomicLoad | Opcode::AtomicStore if self.on_aarch64() => {
1503                    self.ordered(inst)?;
1504                    continue;
1505                }
1506                // A hint, written by name for the reason a barrier is and one step further: not
1507                // only is there no equality for a proof to discharge, there is nothing about the
1508                // program around it either. Which of the four instructions it is comes out of the
1509                // number the builtin was given, which is beside the instruction rather than in it.
1510                Opcode::Prefetch => {
1511                    self.hint(inst)?;
1512                    continue;
1513                }
1514                // Stopping, written by name for the first half of the barrier's reason: it
1515                // computes nothing, so there is no term for a rule to replace, and what makes it
1516                // right is what the operating system does with the fault rather than anything a
1517                // proof over bitvectors could discharge.
1518                Opcode::Trap => {
1519                    self.trap(inst);
1520                    continue;
1521                }
1522                // A compare and exchange, which is written by name because it produces two values
1523                // and a rule produces one. The replacement of a rule is one term, a term names the
1524                // value an instruction computes, and there is no way in that language to say that
1525                // an instruction leaves an answer in one place and a yes or no in another.
1526                Opcode::Cmpxchg => {
1527                    self.exchange(inst)?;
1528                    continue;
1529                }
1530                // A read modify write, which is written by name for a different reason: it produces
1531                // one value, so a rule could name it, and what it does is not in the head a rule
1532                // matches on. Every one of the thirteen operations is the same opcode at the same
1533                // type and differs only in what is carried beside it, so one pattern would be all
1534                // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1535                // since `crate::retry` turned the rest into loops a long way above this.
1536                Opcode::AtomicRmw => {
1537                    self.modify(inst)?;
1538                    continue;
1539                }
1540                // An `asm` statement, whose lowering is its template and there is no term for a
1541                // string. Written by name for the reason a barrier is, and before the x87 arm
1542                // below so that an `asm` holding a `long double` is refused as the `asm` it is
1543                // rather than as an instruction nothing computes.
1544                Opcode::InlineAsm => {
1545                    // The template is read as x86 assembly, and that reader is the only one there
1546                    // is. AArch64 keeps every template as text, and any other machine's `asm` is
1547                    // refused here rather than read as the wrong language.
1548                    if self.on_aarch64() {
1549                        self.spelled(inst)?;
1550                        continue;
1551                    }
1552                    if !std::ptr::eq(self.selector.shapes, &x86_64::MACHINE) {
1553                        return Err(self.unsupported(inst));
1554                    }
1555                    if self.touches_x87(inst) {
1556                        self.x87_assembly(inst)?;
1557                        continue;
1558                    }
1559                    self.assembly(inst)?;
1560                    continue;
1561                }
1562                // Anything at all with an eighty bit float in it, which is the one arm here
1563                // chosen by a type rather than by an opcode, because what makes these different
1564                // is not what they do but where the value is. A `long double` has no register,
1565                // so it has no name in `crate::term` and no rule could bind one: every one of
1566                // these is a group of instructions over a frame slot, written out below.
1567                //
1568                // Last of the arms, so that a call and a return with one of these in them reach
1569                // the convention first and are refused by it, which is the truer answer: what is
1570                // wrong there is where the value has to travel and not that nothing can compute
1571                // it.
1572                _ if self.touches_x87(inst) => {
1573                    self.x87(inst)?;
1574                    continue;
1575                }
1576                _ => {}
1577            }
1578            let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1579            self.emit(inst, &matched)?;
1580            // After it is built rather than when it matched, so that what is recorded is the rules
1581            // this function was lowered by and not the rules something was tried with.
1582            self.fired.mark(matched.rule);
1583        }
1584        // Whichever block the walk ended in rather than the one it started in. The two are the
1585        // same block for every function that does not save a place for a `__builtin_longjmp`, and
1586        // where they differ it is the last of them that the terminator and the arms belong to.
1587        // See [`Self::saves_place`].
1588        let last = self.at.expect("a block is being filled");
1589        self.edges(block, last)?;
1590        for (value, reg) in kept {
1591            self.regs[value.index()] = reg;
1592        }
1593        // Now that the block is filled, the instruction after each place an assignment was is the
1594        // first one it holds its value at. One with nothing after it, which a block ending in the
1595        // assignment would be, stays unanswered.
1596        if let Some(marks) = self.marks.get_mut(&block) {
1597            for &(before, at, last) in &reached {
1598                let first = match last {
1599                    Some(last) => self.out.next_inst(last),
1600                    None => self.out.insts(at).next(),
1601                };
1602                for mark in marks.iter_mut().filter(|(after, _)| *after == before) {
1603                    mark.1 = first;
1604                }
1605            }
1606        }
1607        Ok(())
1608    }
1609
1610    /// One call, which is built from the convention rather than matched against the table for the
1611    /// same reason the arguments of the function itself are.
1612    ///
1613    /// The arguments are read before the call is built, which is what materializes a constant
1614    /// argument into a register, since no call passes an immediate.
1615    ///
1616    /// A call to a name and a call through an address are both here, and what tells them apart is
1617    /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1618    /// reads. Through an address the first operand is the address and the arguments are the ones
1619    /// behind it, and everything after that is the same: where each argument goes, where the value
1620    /// comes back and which registers are gone across it are the convention's answers and the
1621    /// convention does not ask what is being called.
1622    fn called(&mut self, inst: Inst) -> Result<u32, Unsupported> {
1623        let data = &self.source[inst];
1624        let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1625        let info = self.source[info];
1626        let indirect = data.opcode == Opcode::CallIndirect;
1627
1628        let values: Vec<Value> = self.source[data.args].to_vec();
1629        let callee = if indirect {
1630            let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1631            abi::Callee::Through(self.reg_of(address)?)
1632        } else {
1633            let symbol = info.callee.ok_or_else(|| self.unsupported(inst))?;
1634            // A function a declaration said is in a DLL is called through the pointer the loader
1635            // fills in, which is what gcc writes at `-O0`: the pointer into a register and a call
1636            // through the register. gcc at `-O2` and clang call through the pointer in memory,
1637            // which is one instruction shorter and the same call.
1638            match self.elsewhere.slot(symbol) {
1639                Some(slot) => {
1640                    let reg = self.out.new_vreg(self.gpr);
1641                    self.through_slot(inst, slot, symbol, reg)?;
1642                    abi::Callee::Through(reg)
1643                }
1644                None => abi::Callee::Named(symbol),
1645            }
1646        };
1647
1648        // What the ABI asks of each argument, read out before any of them is, because reading one
1649        // borrows the function this is a table in. The ones the signature names are the signature's
1650        // answer and the ones behind them are the call's, which is where a structure passed to a
1651        // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1652        let signature = &self.source[info.signature];
1653        let variadic = signature.variadic;
1654        let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1655        let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1656        // Every value that comes back and not only the first. A structure small enough to travel
1657        // in registers comes back in up to two of them, and which register each half is in is the
1658        // convention's answer, which is why the whole list goes to the same place the arguments do
1659        // rather than to a rule.
1660        let returns: Vec<Type> = signature.return_types().collect();
1661
1662        let mut args = Vec::with_capacity(values.len());
1663        for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1664            let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1665            let abi = abi.copied().unwrap_or_default();
1666            let ty = self.source[value].ty;
1667            // What travels for an eighty bit value is its bytes, so what the call is handed is
1668            // where they are rather than a register they are in, and there is no register they
1669            // could be in. Everything else about it is a sixteen byte object passed by value and
1670            // is built by the same code.
1671            let reg =
1672                if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1673            args.push(abi::Passing { ty, reg, abi });
1674        }
1675        let block = self.at.expect("a block is being filled");
1676        let what = abi::Calling {
1677            callee,
1678            args: &args,
1679            returns: &returns,
1680            variadic,
1681            named: named.len(),
1682            at: self.source.span(inst),
1683        };
1684        // The callee's convention and not this function's, since the two differ when either was
1685        // written `ms_abi` or `sysv_abi`: where the arguments go, what the callee leaves alone and
1686        // how much room it is owed above the return address are all the callee's to say, and a
1687        // function of one convention calls functions of the other.
1688        let called = self.source[info.signature].convention;
1689        let conv = self
1690            .conv
1691            .under(called)
1692            .ok_or(Unsupported::Unported { inst: Some(inst), what: Unported::Convention })?;
1693        let made = abi::call(&mut self.out, block, &what, conv, self.selector.abi, self.names)
1694            .map_err(|refused| Unsupported::Call { inst, refused })?;
1695        if self.source.unwinds_to_pad(inst) {
1696            let call = self.out.insts(block).last().expect("the call just built");
1697            self.unwinding.insert(inst, call);
1698        }
1699        let calls = &mut self.stack.calls;
1700        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1701        // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1702        // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1703        // front of everything the block does next, and after it the value is in its slot and is
1704        // read the way every other one is. A complex one is two of them, the real half on top, so
1705        // taking them off in order leaves each in its own slot and the stack empty.
1706        let results: Vec<Value> = self.source[inst].results().collect();
1707        let types: Vec<Type> = results.iter().map(|&result| self.source[result].ty).collect();
1708        if abi::back_on_x87(&types) {
1709            let span = self.source.span(inst);
1710            for result in results {
1711                let into = self.x87_slot(result);
1712                let into = self.through(into);
1713                self.x87_at("fstp_t", span, into);
1714            }
1715            return Ok(made.outgoing);
1716        }
1717        for (result, &reg) in results.into_iter().zip(&made.results) {
1718            self.sized(reg, self.source[result].ty);
1719            self.regs[result.index()] = Some(reg);
1720        }
1721        Ok(made.outgoing)
1722    }
1723
1724    /// One `tail_call`, as the call and a return of what it gave back.
1725    ///
1726    /// The call is written down for [`crate::tail::jumps`] when it can be made after the frame is
1727    /// gone. That is when it put nothing in the argument area, which is the bottom of this frame,
1728    /// and when the answer comes back in registers, since one on the x87 stack is taken off and put
1729    /// back by instructions after the call. A call that is not written down stays a call and a
1730    /// return, which is what the IR said before `crate::tail::mark` read it.
1731    fn tail_called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1732        let outgoing = self.called(inst)?;
1733        let block = self.at.expect("a block is being filled");
1734        let call = self.out.insts(block).last().expect("the call just built");
1735        let values: Vec<Value> = self.source[inst].results().collect();
1736        let x87 = self.x87_values(&values);
1737        self.returned(inst, values)?;
1738        if outgoing == 0 && !x87 && self.sret().is_none() {
1739            let returns = self.out.insts(block).skip_while(|&at| at != call).skip(1).collect();
1740            self.stack.tails.push(crate::tail::Tail { call, returns });
1741        }
1742        Ok(())
1743    }
1744
1745    /// The pointer a function returning through memory was handed, or nothing in a function that
1746    /// was not.
1747    ///
1748    /// It is the first parameter and the signature is what says so, since in the IR it is an
1749    /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1750    /// like that and no entry block has nothing to give back and no body to give it back from.
1751    fn sret(&self) -> Option<Value> {
1752        let first = self.source.signature().params.first()?;
1753        if !matches!(first.abi, Abi::Sret { .. }) {
1754            return None;
1755        }
1756        self.source[self.source.entry()?].params.first().copied()
1757    }
1758
1759    /// One `return` the convention has to write, as the place each value has to be in by the end.
1760    ///
1761    /// One pseudo per value, each a read constrained to a return register, which is what a return
1762    /// of one value already is and is the whole of what either does. The `ret` itself comes from
1763    /// the epilogue for both, long after this, because the frame has to be given back first.
1764    ///
1765    /// The two register files are counted separately, so a structure of a `double` and a `long`
1766    /// leaves the `double` in the first vector register and the `long` in the first integer one
1767    /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1768    /// the other side of the call, which is what makes the two ends agree.
1769    ///
1770    /// A function whose answer went through memory gives back the address it was handed, in front
1771    /// of nothing else, because a signature that returns that way returns nothing else. That the
1772    /// caller already knows the address is not enough: it is allowed to read the register instead,
1773    /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1774    /// is usually the right answer by accident, and one call in the body is enough to make it a
1775    /// wild pointer, which is why this is written rather than left to luck.
1776    ///
1777    /// Where everything goes is worked out before anything is written, so a return this cannot
1778    /// make leaves no half of one behind.
1779    /// Whether a value this function gives back has to be extended first, which is Apple's arm64
1780    /// asking the callee to fill the 32 bits above a `char` or a `short` by its sign.
1781    fn widens_return(&self) -> bool {
1782        let returns = &self.source.signature().returns;
1783        returns.iter().any(|it| (self.selector.abi.extend)(it.ty, it.abi).is_some())
1784    }
1785
1786    /// Whether what a `return` gives back goes back on the x87 stack, per [`abi::back_on_x87`].
1787    fn gives_back_x87(&self, inst: Inst) -> bool {
1788        self.x87_values(&self.source[self.source[inst].args])
1789    }
1790
1791    /// Whether those values go back on the x87 stack, per [`abi::back_on_x87`].
1792    fn x87_values(&self, values: &[Value]) -> bool {
1793        let types: Vec<Type> = values.iter().map(|&value| self.source[value].ty).collect();
1794        abi::back_on_x87(&types)
1795    }
1796
1797    fn returned(&mut self, inst: Inst, values: Vec<Value>) -> Result<(), Unsupported> {
1798        let (mut ints, mut floats) = (0usize, 0usize);
1799        let mut parts = Vec::with_capacity(values.len() + 1);
1800        // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1801        // and is the one place a value is left rather than put in a register. So the whole of the
1802        // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1803        // `ret`, which is the one time in this file that is true and is what the convention asks
1804        // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1805        // the unit. A complex one loads its imaginary half first so that the real half ends up on
1806        // top of it, in `st(0)`, with the imaginary half under it in `st(1)`.
1807        if self.x87_values(&values) && self.sret().is_none() {
1808            let span = self.source.span(inst);
1809            for &value in values.iter().rev() {
1810                let from = self.x87_slot(value);
1811                let from = self.through(from);
1812                self.x87_at("fld_t", span, from);
1813            }
1814            return Ok(());
1815        }
1816        // What the signature says about the bits above a narrow one, which on an ABI that extends
1817        // it is an obligation of this side: the caller reads the whole of the 32 bit register.
1818        let asked: Vec<Abi> = self.source.signature().returns.iter().map(|it| it.abi).collect();
1819        let asked = asked.into_iter().chain(std::iter::repeat(Abi::Plain));
1820        let sret = self.sret().map(|value| (value, Abi::Plain));
1821        for (value, abi) in sret.into_iter().chain(values.into_iter().zip(asked)) {
1822            let ty = self.source[value].ty;
1823            let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1824            // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1825            // says so itself, and a type that travels perfectly well ran out of registers.
1826            let missing = abi::refuses(ty, self.selector.abi).unwrap_or(Missing::NoRoom);
1827            let name =
1828                (self.selector.abi.ret)(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1829            *at += 1;
1830            // The register is the target's answer and not one worked out here, the same as it is
1831            // for a return of one value, so that both halves of a pair and every rule that writes
1832            // half of one are reading the same table.
1833            let opcode =
1834                name.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
1835            let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
1836            let [desc] = descs else { return Err(self.unsupported(inst)) };
1837            let widen = (self.selector.abi.extend)(ty, abi).map(|name| self.names.intern(name));
1838            parts.push((self.names.intern(name), self.reg_of(value)?, *desc, widen));
1839        }
1840
1841        let block = self.at.expect("a block is being filled");
1842        let span = self.source.span(inst);
1843        for (opcode, mut reg, desc, widen) in parts {
1844            if let Some(widen) = widen {
1845                let wide = self.out.new_vreg(desc.class);
1846                let build = self.out.build(block, mir::Opcode::new(widen)).at(span);
1847                build.def(wide, desc.class).uses(reg, desc.class).finish();
1848                reg = wide;
1849            }
1850            let operand = mir::Operand {
1851                reg,
1852                class: desc.class,
1853                role: desc.role,
1854                constraint: desc.constraint,
1855            };
1856            self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1857        }
1858        Ok(())
1859    }
1860
1861    /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1862    /// address of them is one instruction.
1863    ///
1864    /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1865    /// the frame in every function, and its displacement is left at nothing because there is no
1866    /// frame yet. Which instruction is waiting for which local is remembered, and
1867    /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1868    ///
1869    /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1870    /// that is what stops it being folded into something else. An operand shown as the
1871    /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1872    /// name is one no pattern can reach past, and the address it computes is always in a register
1873    /// by the time anything reads it.
1874    fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1875        let data = &self.source[inst];
1876        // A variable length array carries the size it wants as an operand rather than in the
1877        // instruction, which is the whole of what tells the two apart here.
1878        if let Some(&size) = self.source[data.args].first() {
1879            return self.grow(inst, size);
1880        }
1881        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1882        let info = self.source[mem];
1883        let size = u32::try_from(info.size)
1884            .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1885        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1886
1887        // At least one, because the frame divides by the alignment and an object with no
1888        // alignment at all is one the front end had nothing to say about rather than one that may
1889        // go anywhere.
1890        let index = self.stack.locals.len();
1891        self.stack.locals.push(Local { size, align: info.align.max(1) });
1892        if let Some(decl) = self.source.mem_decl(mem) {
1893            self.stack.declared.push((index, decl));
1894        }
1895
1896        let block = self.at.expect("a block is being filled");
1897        let reg = self.new_reg(result);
1898        let span = self.source.span(inst);
1899        let lea = self.named(self.selector.frame.lea);
1900        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1901        let made =
1902            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1903        self.stack.addresses.push((made, index));
1904        self.frame_slots.insert(result, index);
1905        Ok(())
1906    }
1907
1908    /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1909    /// is what a variable length array is.
1910    ///
1911    /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1912    /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1913    /// where the declaration stands, which is two instructions:
1914    ///
1915    /// ```text
1916    ///   sub sp, bytes     the stack pointer moves down over the memory, which is what takes it
1917    ///   lea reg, [sp+n]   where the memory starts, which is above the outgoing argument area
1918    /// ```
1919    ///
1920    /// The displacement is left at nothing for the reason the constant kind leaves its own at
1921    /// nothing, and for a different number: that area belongs to the arguments of whatever this
1922    /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1923    /// how big it is is not known until every call in the function has been seen.
1924    ///
1925    /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1926    /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1927    /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1928    ///
1929    /// Two instructions here and not always two in the finished function. On a command line that
1930    /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1931    /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1932    /// instruction is written down in [`Stack::grown`] as well as left where it is.
1933    ///
1934    /// An array wanting more alignment than the convention leaves the stack pointer with does not
1935    /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1936    /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1937    /// is a block asking for the convention's alignment like any other. The refusal below is what
1938    /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1939    /// would be a second rounding of a register the frame already rounded, and after it no
1940    /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1941    fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1942        let data = &self.source[inst];
1943        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1944        let info = self.source[mem];
1945        if info.align > self.conv.stack_align {
1946            return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1947        }
1948        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1949        let bytes = self.reg_of(size)?;
1950
1951        let block = self.at.expect("a block is being filled");
1952        let span = self.source.span(inst);
1953        let stack = mir::Reg::physical(self.conv.stack_pointer);
1954        let grow = self.named(self.selector.frame.grow);
1955        let took = self
1956            .out
1957            .build(block, grow)
1958            .at(span)
1959            .operand(mir::Operand::write(stack, self.gpr))
1960            .operand(mir::Operand::read(stack, self.gpr))
1961            .operand(mir::Operand::read(bytes, self.gpr))
1962            .finish();
1963        self.stack.grown.push(took);
1964
1965        let reg = self.new_reg(result);
1966        let lea = self.named(self.selector.frame.lea);
1967        let sp = mir::Operand::read(stack, self.gpr);
1968        let made =
1969            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1970        self.stack.dynamic.push(made);
1971        self.stack.grown_at.get_or_insert(inst);
1972        Ok(())
1973    }
1974
1975    /// Where the stack pointer is, kept so that something later can put it back.
1976    ///
1977    /// One move out of the stack pointer and one move into it, which is the whole of what the two
1978    /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1979    /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1980    /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1981    /// jump out of the scope gives the bytes back on the way out.
1982    ///
1983    /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1984    /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
1985    /// which is exactly the register that still means something after the stack pointer has moved.
1986    fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
1987        let data = &self.source[inst];
1988        let block = self.at.expect("a block is being filled");
1989        let span = self.source.span(inst);
1990        let stack = mir::Reg::physical(self.conv.stack_pointer);
1991        let mov =
1992            self.selector.frame.moves(self.gpr).expect("a class the target says how to move").mov;
1993        let mov = self.named(mov);
1994        let (write, read) = if into {
1995            let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
1996            (stack, self.reg_of(saved)?)
1997        } else {
1998            let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1999            (self.new_reg(result), stack)
2000        };
2001        self.out
2002            .build(block, mov)
2003            .at(span)
2004            .operand(mir::Operand::write(write, self.gpr))
2005            .operand(mir::Operand::read(read, self.gpr))
2006            .finish();
2007        // Only the write is a move of the stack pointer, and it is the one that makes the frame a
2008        // growing one. A read of it in a function that never writes it back is a function that
2009        // asked where the stack was and did nothing with the answer.
2010        if into {
2011            self.stack.grown_at.get_or_insert(inst);
2012        }
2013        Ok(())
2014    }
2015
2016    /// Whether an instruction has an eighty bit float anywhere in it.
2017    ///
2018    /// Producing one and reading one are the same question here, because what makes one of these
2019    /// different from every other instruction is not the operation but where the value is. A
2020    /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
2021    /// of the time, and neither of those is somewhere the operand of a rule could point.
2022    fn touches_x87(&self, inst: Inst) -> bool {
2023        let data = &self.source[inst];
2024        data.results().any(|value| on_x87(self.source[value].ty))
2025            || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
2026    }
2027
2028    /// Everything that happens to an eighty bit float, as the group of instructions it is.
2029    ///
2030    /// The first six move one, and every one of those is a load, a store, or a load and a store at
2031    /// two different formats, because that is the whole of what this machine converts with: the
2032    /// x87 has no instruction that turns one thing on its stack into another, so a widening is
2033    /// `fld` of the narrow format and a narrowing is `fstp` of it.
2034    ///
2035    /// The rest work on one, and they are here rather than in a rule for the same reason the six
2036    /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
2037    /// top of a stack nothing allocates from, so there is no value in the middle of the group for
2038    /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
2039    /// two instructions folded into one opcode, which is where the byte it produces comes from.
2040    ///
2041    /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
2042    /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
2043    /// below is answered by a pop a line or two later, so no two groups can ever be looking at
2044    /// the same eight registers.
2045    fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
2046        match self.source[inst].opcode {
2047            Opcode::Load => self.x87_load(inst),
2048            Opcode::Store => self.x87_store(inst),
2049            Opcode::FPExt => self.x87_widen(inst),
2050            Opcode::FPTrunc => self.x87_narrow(inst),
2051            Opcode::SIToFP => self.x87_from_signed(inst),
2052            Opcode::FPToSI => self.x87_to_signed(inst),
2053            Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
2054            Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
2055            Opcode::FMul => self.x87_arith(inst, "fmul_p"),
2056            Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
2057            Opcode::FNeg => self.x87_flip(inst),
2058            Opcode::FCmp => self.x87_compare(inst),
2059            Opcode::FConst => self.x87_const(inst),
2060            _ => Err(self.unsupported(inst)),
2061        }
2062    }
2063
2064    /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
2065    /// into slots of the block's own.
2066    ///
2067    /// What crosses an edge for a value of this type is an address, because the value is sixteen
2068    /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
2069    /// second edge into the same block hands over a second one, and a read after the block would
2070    /// then be a read of whichever edge was taken rather than of one place. So the block has a
2071    /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
2072    /// every other type gets from the allocator.
2073    ///
2074    /// Every load runs before every store and the stores run backwards, so all of the values are
2075    /// on the x87 stack at once and nothing reads a slot another one has already written. That
2076    /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
2077    /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
2078    /// deep, and a block with more of these than that is refused rather than copied in an order
2079    /// that could be wrong.
2080    fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
2081        let Some(&(first, _)) = arriving.first() else { return Ok(()) };
2082        if arriving.len() > X87_DEPTH {
2083            let ty = self.source[first].ty;
2084            return Err(Unsupported::Phi { block, count: arriving.len(), ty });
2085        }
2086        // A block parameter comes from no instruction, so what this points at is the first thing
2087        // in the block, which is where a reader looking for the copy would look.
2088        let first_inst = self.source.insts(block).next();
2089        let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
2090        for &(_, reg) in arriving {
2091            let from = self.through(reg);
2092            self.x87_at("fld_t", span, from);
2093        }
2094        for &(param, _) in arriving.iter().rev() {
2095            let into = self.x87_slot(param);
2096            let into = self.through(into);
2097            self.x87_at("fstp_t", span, into);
2098        }
2099        Ok(())
2100    }
2101
2102    /// The frame slot an eighty bit value lives in, as its address in a fresh register.
2103    ///
2104    /// The slot is the value's for the whole function and is taken the first time somebody asks.
2105    /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
2106    /// address kept in a register from the definition to the last use would hold a general purpose
2107    /// register open across everything in between, and a function with a handful of these in it
2108    /// would spend its registers on addresses of things rather than on things.
2109    fn x87_slot(&mut self, value: Value) -> mir::Reg {
2110        // An argument of the function has a slot already and it is the caller's. The convention
2111        // puts the bytes in the argument area and hands over where they are, so the address that
2112        // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
2113        // value of this type once it exists, so nothing writes to the caller's copy either. A
2114        // parameter of any other block is not this: what arrived there is an address a predecessor
2115        // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
2116        // bytes landed in is the one below.
2117        let entry = self.source.entry();
2118        if let (Def::Param { block, .. }, Some(reg)) =
2119            (self.source[value].def, self.regs[value.index()])
2120        {
2121            if entry == Some(block) {
2122                return reg;
2123            }
2124        }
2125        let index = match self.slots[value.index()] {
2126            Some(index) => index,
2127            None => {
2128                let index = self.stack.locals.len();
2129                self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
2130                self.slots[value.index()] = Some(index);
2131                index
2132            }
2133        };
2134        let block = self.at.expect("a block is being filled");
2135        self.frame_address(block, index)
2136    }
2137
2138    /// The bytes a value crosses between a register and the x87 stack through, as their address
2139    /// in a fresh register.
2140    fn x87_crossing(&mut self) -> mir::Reg {
2141        let index = match self.crossing {
2142            Some(index) => index,
2143            None => {
2144                let index = self.stack.locals.len();
2145                self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
2146                self.crossing = Some(index);
2147                index
2148            }
2149        };
2150        let block = self.at.expect("a block is being filled");
2151        self.frame_address(block, index)
2152    }
2153
2154    /// The two control words, as the address of the first of them in a fresh register.
2155    fn x87_control(&mut self) -> mir::Reg {
2156        let index = match self.control {
2157            Some(index) => index,
2158            None => {
2159                let index = self.stack.locals.len();
2160                self.stack.locals.push(Local { size: 4, align: 4 });
2161                self.control = 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    /// An address held in a register, as the addressing mode that reaches it.
2170    fn through(&self, reg: mir::Reg) -> mir::Mem {
2171        mir::Mem::at(mir::Operand::read(reg, self.gpr))
2172    }
2173
2174    /// One instruction of a group, which names an address and nothing else.
2175    ///
2176    /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
2177    /// the mnemonic rather than in an operand, so there is no register to write down and no
2178    /// register the allocator gets a say in.
2179    fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
2180        let block = self.at.expect("a block is being filled");
2181        let opcode = self.named(name);
2182        self.out.build(block, opcode).at(span).mem(at).finish();
2183    }
2184
2185    /// The one instruction of a group that reaches the program's own memory.
2186    ///
2187    /// A `long double` moves in two instructions with a frame slot at one end of them, and the
2188    /// other end is the address the program wrote. That end is the access, so it is the one that
2189    /// carries what the program said about it, and the trip through the slot is this compiler's
2190    /// own business the way a spill is. See [`Self::carried`].
2191    fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
2192        let block = self.at.expect("a block is being filled");
2193        let opcode = self.named(name);
2194        let (span, flags) = (self.source.span(inst), self.carried(inst));
2195        self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
2196    }
2197
2198    /// One instruction of a group that names nothing at all.
2199    ///
2200    /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
2201    /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
2202    /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
2203    /// from. What it works on is which two pushes came before it, which is a fact about the order
2204    /// of the group and is why the group is written in one place.
2205    fn x87_only(&mut self, name: &str, span: Span) {
2206        let block = self.at.expect("a block is being filled");
2207        let opcode = self.named(name);
2208        self.out.build(block, opcode).at(span).finish();
2209    }
2210
2211    /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
2212    ///
2213    /// Two instructions rather than the two general purpose moves the same sixteen bytes would
2214    /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
2215    /// in the format it was already in and comes back off in it, so a signalling NaN stays one
2216    /// and nothing is raised. Which is what makes this a copy at all.
2217    fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
2218        let (args, result) = self.ends(inst)?;
2219        let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
2220        let span = self.source.span(inst);
2221        let from = self.reg_of(address)?;
2222        let from = self.through(from);
2223        let into = self.x87_slot(result);
2224        let into = self.through(into);
2225        self.x87_touching("fld_t", inst, from);
2226        self.x87_at("fstp_t", span, into);
2227        Ok(())
2228    }
2229
2230    /// A `store` of a `long double`: the same pair the other way round.
2231    fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
2232        let args = self.source[self.source[inst].args].to_vec();
2233        let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
2234        let span = self.source.span(inst);
2235        let from = self.x87_slot(value);
2236        let from = self.through(from);
2237        let into = self.reg_of(address)?;
2238        let into = self.through(into);
2239        self.x87_at("fld_t", span, from);
2240        self.x87_touching("fstp_t", inst, into);
2241        Ok(())
2242    }
2243
2244    /// A `float`, a `double` or an integer becoming a `long double`.
2245    ///
2246    /// Through memory, because the x87 reads memory and nothing else: the value is in a register
2247    /// the machine has and the unit has no way to be handed one, so it is written to the crossing
2248    /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
2249    /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
2250    /// sixty four bit integer outright, so none of the four can round and none can raise.
2251    fn x87_across(
2252        &mut self,
2253        inst: Inst,
2254        put: &'static str,
2255        class: RegClass,
2256        get: &'static str,
2257    ) -> Result<(), Unsupported> {
2258        let (args, result) = self.ends(inst)?;
2259        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2260        let span = self.source.span(inst);
2261        let value = self.reg_of(source)?;
2262        let across = self.x87_crossing();
2263        let across = self.through(across);
2264        let into = self.x87_slot(result);
2265        let into = self.through(into);
2266
2267        let block = self.at.expect("a block is being filled");
2268        let store = self.named(put);
2269        self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
2270        self.x87_at(get, span, across);
2271        self.x87_at("fstp_t", span, into);
2272        Ok(())
2273    }
2274
2275    /// A `long double` becoming a `float`, a `double` or an integer.
2276    ///
2277    /// Through memory for the reason above and in the same three instructions backwards. The two
2278    /// that go to a float round to nearest, which is what the control word says unless somebody
2279    /// has changed it and is what C wants. The two that go to an integer do not, which is why they
2280    /// do not come here.
2281    fn x87_back(
2282        &mut self,
2283        inst: Inst,
2284        put: &'static str,
2285        get: &'static str,
2286        class: RegClass,
2287    ) -> Result<(), Unsupported> {
2288        let (args, result) = self.ends(inst)?;
2289        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2290        let span = self.source.span(inst);
2291        let from = self.x87_slot(source);
2292        let from = self.through(from);
2293        let across = self.x87_crossing();
2294        let across = self.through(across);
2295
2296        self.x87_at("fld_t", span, from);
2297        self.x87_at(put, span, across);
2298        let block = self.at.expect("a block is being filled");
2299        let reg = self.new_reg(result);
2300        let load = self.named(get);
2301        self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
2302        Ok(())
2303    }
2304
2305    /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
2306    fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
2307        let sse = self.conv.sse_class;
2308        match self.source[self.narrow(inst)?].ty.bits() {
2309            32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
2310            64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
2311            _ => Err(self.unsupported(inst)),
2312        }
2313    }
2314
2315    /// An `fptrunc` down from a `long double`, which is the other direction of the same.
2316    fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
2317        let sse = self.conv.sse_class;
2318        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2319        match self.source[result].ty.bits() {
2320            32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
2321            64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
2322            _ => Err(self.unsupported(inst)),
2323        }
2324    }
2325
2326    /// A `sitofp` up to a `long double`.
2327    ///
2328    /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
2329    /// before it converts one and the front end writes that widening down. An unsigned integer is
2330    /// not here at all: `fild` reads its operand as signed, so a value above the signed range
2331    /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
2332    /// rather than a move and waits with the rest of it.
2333    fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2334        let gpr = self.gpr;
2335        match self.source[self.narrow(inst)?].ty.bits() {
2336            32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
2337            64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
2338            _ => Err(self.unsupported(inst)),
2339        }
2340    }
2341
2342    /// An `fptosi` down from a `long double`, which is the one conversion here with no single
2343    /// instruction behind it.
2344    ///
2345    /// C cuts towards zero and the unit rounds the way its control word says, so the store that
2346    /// takes the value off the stack is wrapped in the control word being saved, changed and put
2347    /// back. Five instructions around the one that does the work, and three more moving the word
2348    /// through a register, because this machine has no way to OR a constant into memory at this
2349    /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
2350    /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
2351    /// that can gate an instruction on a feature yet.
2352    fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2353        let (args, result) = self.ends(inst)?;
2354        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2355        let (put, get) = match self.source[result].ty.bits() {
2356            32 => ("fistp_l", "mov_rm_32"),
2357            64 => ("fistp_ll", "mov_rm_64"),
2358            _ => return Err(self.unsupported(inst)),
2359        };
2360        let span = self.source.span(inst);
2361        let gpr = self.gpr;
2362        let from = self.x87_slot(source);
2363        let from = self.through(from);
2364        let across = self.x87_crossing();
2365        let across = self.through(across);
2366        let control = self.x87_control();
2367        let saved = self.through(control).plus(0);
2368        let cut = self.through(control).plus(2);
2369
2370        // The word the unit has now, into the first of the two slots and into a register, with the
2371        // rounding field turned to truncate on the way to the second.
2372        self.x87_at("fnstcw", span, saved);
2373        let block = self.at.expect("a block is being filled");
2374        let was = self.out.new_vreg(gpr);
2375        let read = self.named("mov_rm_16");
2376        self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
2377        let now = self.out.new_vreg(gpr);
2378        let set = self.named("or_ri_16");
2379        // Two address, which is written out here rather than taken from the two shorthands
2380        // because the shorthands leave an operand unconstrained: this machine ORs into the
2381        // register it read, so the two have to be the same one and only the constraint says so.
2382        self.out
2383            .build(block, set)
2384            .at(span)
2385            .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
2386            .operand(mir::Operand::read(was, gpr))
2387            .imm(X87_TRUNCATE)
2388            .finish();
2389        let write = self.named("mov_mr_16");
2390        self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
2391
2392        // The conversion itself, under the changed word, and then the word the unit had put back
2393        // before anything else runs.
2394        self.x87_at("fldcw", span, cut);
2395        self.x87_at("fld_t", span, from);
2396        self.x87_at(put, span, across);
2397        self.x87_at("fldcw", span, saved);
2398
2399        let block = self.at.expect("a block is being filled");
2400        let reg = self.new_reg(result);
2401        let load = self.named(get);
2402        self.out.build(block, load).at(span).def(reg, gpr).mem(across).finish();
2403        Ok(())
2404    }
2405
2406    /// A constant of this type, as the bits of it written into its slot.
2407    ///
2408    /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
2409    /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
2410    /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
2411    ///
2412    /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
2413    /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
2414    /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
2415    /// wide and they are unspecified in the psABI rather than zero.
2416    ///
2417    /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
2418    /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
2419    /// four instructions in the frame is what that costs until it does.
2420    fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
2421        let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
2422        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2423        let bits = self.source[imm].bits();
2424        let span = self.source.span(inst);
2425        let gpr = self.gpr;
2426        let slot = self.x87_slot(result);
2427        let low = self.through(slot).plus(0);
2428        let high = self.through(slot).plus(8);
2429
2430        let block = self.at.expect("a block is being filled");
2431        for (bytes, at, into) in
2432            [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
2433        {
2434            let held = self.out.new_vreg(gpr);
2435            let put = self.named(&format!("mov_ri_{into}"));
2436            self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
2437            let store = self.named(&format!("mov_mr_{into}"));
2438            self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
2439        }
2440        Ok(())
2441    }
2442
2443    /// One arithmetic instruction on two eighty bit values, as the four it takes.
2444    ///
2445    /// The left operand is pushed first and the right one on top of it, so the left ends up
2446    /// underneath and the answer wanted is the one below against the top in that order. Which of
2447    /// the two mnemonics computes that is a question about the spelling rather than about the
2448    /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
2449    /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
2450    /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
2451    /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
2452    ///
2453    /// An addition and a multiplication have one form each and do not care, which is why a test
2454    /// that reads the mnemonic back would not have caught this and one that computes a subtraction
2455    /// and checks the answer does.
2456    ///
2457    /// The answer is left where the deeper of the two was and the shallower is gone, which is what
2458    /// the `p` on the mnemonic means, so one push has already been paid back by the time the
2459    /// `fstp` runs and the stack is level again after it.
2460    ///
2461    /// Nothing here is folded and nothing is reused. Two values that are the same value get two
2462    /// pushes of the same slot, and an operand that was just computed is read back out of the slot
2463    /// it was written to rather than left on the stack, which costs a store and a load per
2464    /// instruction in an expression. Keeping a partial result on the stack across the next
2465    /// instruction's operands means knowing how deep the stack is at every point in the block, and
2466    /// that is a different thing from writing a group.
2467    fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
2468        let (args, result) = self.ends(inst)?;
2469        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2470        let span = self.source.span(inst);
2471        let left = self.x87_slot(left);
2472        let left = self.through(left);
2473        let right = self.x87_slot(right);
2474        let right = self.through(right);
2475        let into = self.x87_slot(result);
2476        let into = self.through(into);
2477        self.x87_at("fld_t", span, left);
2478        self.x87_at("fld_t", span, right);
2479        self.x87_only(with, span);
2480        self.x87_at("fstp_t", span, into);
2481        Ok(())
2482    }
2483
2484    /// A negation, which is a push, the sign bit turned over and a pop.
2485    ///
2486    /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
2487    /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
2488    /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
2489    /// negative zero and a signalling one at a NaN.
2490    fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
2491        let (args, result) = self.ends(inst)?;
2492        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2493        let span = self.source.span(inst);
2494        let from = self.x87_slot(source);
2495        let from = self.through(from);
2496        let into = self.x87_slot(result);
2497        let into = self.through(into);
2498        self.x87_at("fld_t", span, from);
2499        self.x87_only("fchs", span);
2500        self.x87_at("fstp_t", span, into);
2501        Ok(())
2502    }
2503
2504    /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
2505    ///
2506    /// The right operand is pushed first and the left one on top of it, which is the other way
2507    /// round from the arithmetic and is because `fucomip` asks about the top against what is under
2508    /// it: the comparison this machine can do is the top's, so the value the predicate is about
2509    /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
2510    /// flags are both inside the opcode, since what passes between those and the comparison is the
2511    /// flags and the flags are not something anything here can name.
2512    ///
2513    /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
2514    /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
2515    /// picked a different condition here than there would be a `long double` comparison that
2516    /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
2517    /// wider format is not allowed to do.
2518    ///
2519    /// The always false and the always true are refused rather than folded into a constant,
2520    /// because a comparison this machine never has to do is one the optimizer should have removed
2521    /// and an instruction here that quietly agreed with it would hide that it did not.
2522    fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2523        let Extra::FloatPred(pred) = self.source[inst].extra else {
2524            return Err(self.unsupported(inst));
2525        };
2526        let (args, result) = self.ends(inst)?;
2527        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2528        // Two of the fourteen need a second byte and an instruction to put the two together,
2529        // because they are two conditions at once: an ordered equal is equal and not unordered,
2530        // and an unordered not equal is either. The opcode carries all of that and says here only
2531        // that it writes somewhere else as well.
2532        let (name, reversed, both) = match pred {
2533            FloatPred::Ogt => ("fucomip_set_a", false, false),
2534            FloatPred::Oge => ("fucomip_set_ae", false, false),
2535            FloatPred::Olt => ("fucomip_set_a", true, false),
2536            FloatPred::Ole => ("fucomip_set_ae", true, false),
2537            FloatPred::One => ("fucomip_set_ne", false, false),
2538            FloatPred::Ord => ("fucomip_set_np", false, false),
2539            FloatPred::Uno => ("fucomip_set_p", false, false),
2540            FloatPred::Ueq => ("fucomip_set_e", false, false),
2541            FloatPred::Ult => ("fucomip_set_b", false, false),
2542            FloatPred::Ule => ("fucomip_set_be", false, false),
2543            FloatPred::Ugt => ("fucomip_set_b", true, false),
2544            FloatPred::Uge => ("fucomip_set_be", true, false),
2545            FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2546            FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2547            FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2548        };
2549        let (top, under) = if reversed { (right, left) } else { (left, right) };
2550
2551        let span = self.source.span(inst);
2552        let gpr = self.gpr;
2553        let under = self.x87_slot(under);
2554        let under = self.through(under);
2555        let top = self.x87_slot(top);
2556        let top = self.through(top);
2557        self.x87_at("fld_t", span, under);
2558        self.x87_at("fld_t", span, top);
2559
2560        let block = self.at.expect("a block is being filled");
2561        let reg = self.new_reg(result);
2562        // Taken before the instruction is started rather than inside it, since both come from the
2563        // same function being built and only one thing at a time may be adding to it.
2564        let spare = both.then(|| self.out.new_vreg(gpr));
2565        let opcode = self.named(name);
2566        let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2567        if let Some(spare) = spare {
2568            build = build.def(spare, gpr);
2569        }
2570        build.finish();
2571        Ok(())
2572    }
2573
2574    /// The operands and the one result of an instruction that has exactly one.
2575    fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2576        let data = &self.source[inst];
2577        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2578        Ok((&self.source[data.args], result))
2579    }
2580
2581    /// The operand of a conversion, which is the end of it that is not the `long double`.
2582    fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2583        let args = &self.source[self.source[inst].args];
2584        args.first().copied().ok_or_else(|| self.unsupported(inst))
2585    }
2586
2587    /// One `va_start`, as the fields of the list it was handed.
2588    ///
2589    /// On the four field list, two of them are numbers this already knows, and each costs an
2590    /// instruction to put in a register before it can be stored, because the machine here has no
2591    /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2592    /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2593    /// and the caller's argument area is where the parameters that had no register came from, which
2594    /// is the same place and the same fixup a parameter past the sixth already uses.
2595    ///
2596    /// On the list that is a pointer it is the second of those four and nothing else, since the
2597    /// whole of what that list says is where the walk is and the walk starts at the first argument
2598    /// the signature does not name. One `lea` and one store.
2599    ///
2600    /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2601    /// laid out, so that reading this beside that table is the whole of the check.
2602    fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2603        let Some(&list) = self.source[self.source[inst].args].first() else {
2604            return Err(self.unsupported(inst));
2605        };
2606        let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2607        let list = self.reg_of(list)?;
2608        let block = self.at.expect("a block is being filled");
2609        let span = self.source.span(inst);
2610
2611        let (save, incoming) = match started {
2612            Varargs::Pointer { incoming } => (None, incoming),
2613            Varargs::Fields { save, incoming, integers, floats } => {
2614                let counts = [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)];
2615                for (at, count) in counts {
2616                    self.store_small(list, at, i64::from(count), span);
2617                }
2618                (Some(save), incoming)
2619            }
2620            Varargs::Aapcs { save, incoming, integers_end, floats_end, integers, floats } => {
2621                let counts =
2622                    [(varargs::aapcs::GR_OFFS, integers), (varargs::aapcs::VR_OFFS, floats)];
2623                for (at, count) in counts {
2624                    self.store_small(list, at, i64::from(count), span);
2625                }
2626                let overflow = self.overflow(block, incoming, span);
2627                let integers_top = self.frame_address_plus(block, save, integers_end);
2628                let floats_top = self.frame_address_plus(block, save, floats_end);
2629                let fields = [
2630                    (varargs::aapcs::STACK, overflow),
2631                    (varargs::aapcs::GR_TOP, integers_top),
2632                    (varargs::aapcs::VR_TOP, floats_top),
2633                ];
2634                for (at, held) in fields {
2635                    self.store_word(list, at, held, span);
2636                }
2637                return Ok(());
2638            }
2639        };
2640
2641        // At the front of the list when that address is the whole of it, and at the field the
2642        // layout gives it when there are four, with the save area behind it.
2643        let overflow = self.overflow(block, incoming, span);
2644        let fields = match save {
2645            None => vec![(0, overflow)],
2646            Some(save) => {
2647                let save = self.frame_address(block, save);
2648                vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2649            }
2650        };
2651        for (at, held) in fields {
2652            self.store_word(list, at, held, span);
2653        }
2654        Ok(())
2655    }
2656
2657    /// The first argument the signature did not name, which is as far up the caller's argument
2658    /// area as the ones it did name reached. Nothing here knows where that area is, so the distance
2659    /// is recorded the way a parameter read out of it is and finished with it.
2660    fn overflow(&mut self, block: mir::Block, incoming: u32, span: Span) -> mir::Reg {
2661        let overflow = self.out.new_vreg(self.gpr);
2662        let lea = self.named(self.selector.frame.lea);
2663        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2664        let made = self
2665            .out
2666            .build(block, lea)
2667            .at(span)
2668            .def(overflow, self.gpr)
2669            .mem(mir::Mem::at(sp))
2670            .finish();
2671        self.stack.arguments.push((made, incoming));
2672        overflow
2673    }
2674
2675    /// Writes a small constant into a 32 bit field of a list.
2676    fn store_small(&mut self, list: mir::Reg, at: i64, value: i64, span: Span) {
2677        let block = self.at.expect("a block is being filled");
2678        let held = self.out.new_vreg(self.gpr);
2679        let load = mir::Opcode::new(self.names.intern(self.selector.abi.small));
2680        self.out.build(block, load).at(span).def(held, self.gpr).imm(value).finish();
2681
2682        let head = (self.selector.abi.store)(Type::int(32)).expect("a store of a word");
2683        let store = mir::Opcode::new(self.names.intern(head));
2684        let mem = self.field(list, at);
2685        self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2686    }
2687
2688    /// Writes an address into a pointer field of a list.
2689    fn store_word(&mut self, list: mir::Reg, at: i64, held: mir::Reg, span: Span) {
2690        let block = self.at.expect("a block is being filled");
2691        let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
2692        let store = mir::Opcode::new(self.names.intern(head));
2693        let mem = self.field(list, at);
2694        self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2695    }
2696
2697    /// One field of a list, as the addressing mode that reaches it.
2698    fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2699        let base = mir::Operand::read(list, self.gpr);
2700        mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2701    }
2702
2703    /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2704    ///
2705    /// That is x86-64, and [`Selector::symbols`] is what says so. AArch64 writes the same thing as
2706    /// an `adrp` of the page and an `add` of the low twelve bits, which is one opcode with the name
2707    /// as its own symbol and no addressing mode, and the table read is an `adrp` and an `ldr`.
2708    ///
2709    /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2710    /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2711    /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2712    /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2713    /// the encoder emits the relocation, because a call to a name the file does not define needed
2714    /// them first.
2715    ///
2716    /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2717    /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2718    /// this program can work out, and the address of a function this file merely declares is not
2719    /// such a number. The load reads the address out of the slot the linker fills in instead. The
2720    /// linker turns it back into the `lea` when the name turns out to have been here all along,
2721    /// so this is not slower in the case that was already right.
2722    ///
2723    /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2724    /// being folded into the instruction that reads it. Folding it is the right thing to do and
2725    /// is what turns a load of a global from two instructions into one, but it is a separate
2726    /// question about addressing modes and issue #282 is it. Until then the address is in a
2727    /// register before anything uses it, which is correct and one instruction longer.
2728    ///
2729    /// What this does not do is give the name anything to refer to. A module carries its globals
2730    /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2731    /// reference the linker cannot resolve. Issue #293 is the other half.
2732    ///
2733    /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2734    fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2735        let data = &self.source[inst];
2736        let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2737        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2738        if self.elsewhere.thread(symbol) {
2739            return self.thread_address(inst, symbol, result);
2740        }
2741        if let Some(slot) = self.elsewhere.slot(symbol) {
2742            let reg = self.new_reg(result);
2743            return self.through_slot(inst, slot, symbol, reg);
2744        }
2745
2746        let block = self.at.expect("a block is being filled");
2747        let reg = self.new_reg(result);
2748        let span = self.source.span(inst);
2749        let far = self.elsewhere.holds(symbol);
2750        let symbols = self.selector.symbols;
2751        match if far { symbols.far } else { symbols.near } {
2752            Reach::Mode(name) => {
2753                let mem = if far { mir::Mem::got(symbol) } else { mir::Mem::of(symbol) };
2754                let opcode = self.named(name);
2755                self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2756            }
2757            Reach::Own(name) => {
2758                let opcode = self.named(name);
2759                self.out.build(block, opcode).at(span).def(reg, self.gpr).symbol(symbol).finish();
2760            }
2761        }
2762        Ok(())
2763    }
2764
2765    /// The address of a name on COFF that is reached through a pointer, into `reg`.
2766    ///
2767    /// One load of the pointer from the instruction pointer, which is the same instruction the
2768    /// global offset table is read with on the other formats and for much the same reason: the
2769    /// pointer is in this image, so the distance to it is a number the linker has, and what it
2770    /// holds is an address the loader or the runtime writes once the DLL the name is in has been
2771    /// put somewhere. See [`Slot`] for which pointer and who writes it.
2772    ///
2773    /// ```text
2774    /// movq  __imp_GetCurrentProcessId(%rip), %rax
2775    /// movq  .refptr.environ(%rip), %rax
2776    /// ```
2777    fn through_slot(
2778        &mut self,
2779        inst: Inst,
2780        slot: Slot,
2781        symbol: Symbol,
2782        reg: mir::Reg,
2783    ) -> Result<(), Unsupported> {
2784        let Reach::Mode(name) = self.selector.symbols.far else {
2785            return Err(self.unsupported(inst));
2786        };
2787        let block = self.at.expect("a block is being filled");
2788        let span = self.source.span(inst);
2789        let pointer = slot.name(self.names.resolve(symbol));
2790        let pointer = self.names.intern(&pointer);
2791        let opcode = self.named(name);
2792        self.out
2793            .build(block, opcode)
2794            .at(span)
2795            .def(reg, self.gpr)
2796            .mem(mir::Mem::of(pointer))
2797            .finish();
2798        Ok(())
2799    }
2800
2801    /// The address of a thread-local variable, which is this thread's copy of it.
2802    ///
2803    /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2804    /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2805    /// thread and they are at different addresses, so a link asked for the distance to the name
2806    /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2807    /// the same reason.
2808    ///
2809    /// What is the same in every thread is where the variable sits inside the block of storage a
2810    /// thread gets, so that offset is what the link writes down, and the address of the running
2811    /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2812    /// front of the block, so the whole of this is three instructions:
2813    ///
2814    /// ```text
2815    /// movq  x@gottpoff(%rip), %off   # how far into the block x sits, which the link fills in
2816    /// movq  %fs:0, %tp               # where this thread's block is, which only the machine knows
2817    /// addq  %tp, %off                # this thread's copy of x
2818    /// ```
2819    ///
2820    /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2821    /// in an executable, which folds the addition into the instruction that uses the address, and
2822    /// the difference is issue #282 rather than anything about threads: nothing here folds an
2823    /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2824    /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2825    /// table slot costs nothing in the case that is common.
2826    ///
2827    /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2828    /// program is already running, and the block this reaches was laid out before it started, so
2829    /// the loader has to find room in that block for the library's variables. glibc keeps a little
2830    /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2831    /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2832    /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2833    ///
2834    /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2835    /// right for a library the program is linked against, and a load that either works or is
2836    /// refused out loud for a library something opens later. What it is never is quietly wrong.
2837    ///
2838    /// AArch64 Linux is the same three steps. The slot is reached with `adrp` and `ldr` against
2839    /// `:gottprel:`, the thread pointer is `tpidr_el0` read with `mrs`, and the add has three
2840    /// operands. Apple's platforms reach a thread-local variable through a descriptor call instead,
2841    /// which is [`Self::thread_descriptor`].
2842    fn thread_address(
2843        &mut self,
2844        inst: Inst,
2845        symbol: Symbol,
2846        result: Value,
2847    ) -> Result<(), Unsupported> {
2848        if self.elsewhere.described() {
2849            return self.thread_descriptor(inst, symbol, result);
2850        }
2851        if self.elsewhere.indexed() {
2852            return self.thread_indexed(inst, symbol, result);
2853        }
2854        let block = self.at.expect("a block is being filled");
2855        let span = self.source.span(inst);
2856        let gpr = self.gpr;
2857
2858        let offset = self.out.new_vreg(gpr);
2859        match self.selector.symbols.thread {
2860            Reach::Mode(name) => {
2861                let load = self.named(name);
2862                let mem = mir::Mem::thread(symbol);
2863                self.out.build(block, load).at(span).def(offset, gpr).mem(mem).finish();
2864            }
2865            Reach::Own(name) => {
2866                let load = self.named(name);
2867                self.out.build(block, load).at(span).def(offset, gpr).symbol(symbol).finish();
2868            }
2869        }
2870        let pointer = self.out.new_vreg(gpr);
2871        self.read_thread_pointer(block, span, pointer);
2872
2873        // Two address on x86-64, for the reason `x87_to_int` gives: that machine adds into the
2874        // register it read, and only the constraint says the two are the same one.
2875        let reg = self.new_reg(result);
2876        let jumps = self.selector.jumps;
2877        let add = self.named(jumps.add);
2878        let written = mir::Operand::write(reg, gpr);
2879        let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2880        self.out
2881            .build(block, add)
2882            .at(span)
2883            .operand(written)
2884            .operand(mir::Operand::read(offset, gpr))
2885            .operand(mir::Operand::read(pointer, gpr))
2886            .finish();
2887        Ok(())
2888    }
2889
2890    /// A thread-local variable on Mach-O, which is a call.
2891    ///
2892    /// The slot the machine's thread load reads holds the address of the variable's descriptor
2893    /// there, `_v@TLVP` on x86-64 and `_v@TLVPPAGE` with `_v@TLVPPAGEOFF` on AArch64. The first
2894    /// word of the descriptor is the function that finds this thread's copy, and it takes the
2895    /// descriptor's address as its one argument and gives back the copy's address. That is the
2896    /// sequence clang writes on both machines.
2897    ///
2898    /// The call is built as an ordinary call through an address, so it costs what any call costs:
2899    /// everything the convention does not preserve is taken to be gone across it. Apple's function
2900    /// keeps more than that, all but the result and the two scratch registers on AArch64, and
2901    /// taking the fewer registers as gone would be faster. What this gives up is speed, and a
2902    /// function that reads a thread-local is no longer a leaf.
2903    fn thread_descriptor(
2904        &mut self,
2905        inst: Inst,
2906        symbol: Symbol,
2907        result: Value,
2908    ) -> Result<(), Unsupported> {
2909        let block = self.at.expect("a block is being filled");
2910        let span = self.source.span(inst);
2911        let gpr = self.gpr;
2912
2913        let descriptor = self.out.new_vreg(gpr);
2914        match self.selector.symbols.thread {
2915            Reach::Mode(name) => {
2916                let load = self.named(name);
2917                let mem = mir::Mem::thread(symbol);
2918                self.out.build(block, load).at(span).def(descriptor, gpr).mem(mem).finish();
2919            }
2920            Reach::Own(name) => {
2921                let load = self.named(name);
2922                let build = self.out.build(block, load).at(span);
2923                build.def(descriptor, gpr).symbol(symbol).finish();
2924            }
2925        }
2926        let finder = self.out.new_vreg(gpr);
2927        let word = (self.selector.abi.load)(Type::PTR).ok_or_else(|| self.unsupported(inst))?;
2928        let word = mir::Opcode::new(self.names.intern(word));
2929        let mem = mir::Mem::at(mir::Operand::read(descriptor, gpr));
2930        self.out.build(block, word).at(span).def(finder, gpr).mem(mem).finish();
2931
2932        let args = [abi::Passing { ty: Type::PTR, reg: descriptor, abi: Abi::default() }];
2933        let what = abi::Calling {
2934            callee: abi::Callee::Through(finder),
2935            args: &args,
2936            returns: &[Type::PTR],
2937            variadic: false,
2938            named: 1,
2939            at: span,
2940        };
2941        let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
2942            .map_err(|refused| Unsupported::Call { inst, refused })?;
2943        let calls = &mut self.stack.calls;
2944        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
2945        let &[reg] = &made.results[..] else { return Err(self.unsupported(inst)) };
2946        self.regs[result.index()] = Some(reg);
2947        Ok(())
2948    }
2949
2950    /// A thread-local variable on Windows, which is four loads and no call.
2951    ///
2952    /// `_tls_index` is this image's slot in the array of `.tls` copies the thread block holds at
2953    /// `%gs:88`, and the variable is as far into this thread's copy as it is into the section. The
2954    /// C runtime defines the index and the linker writes the offset. See [`crate::select::Indexed`] for
2955    /// the four instructions, which are the ones gcc writes.
2956    fn thread_indexed(
2957        &mut self,
2958        inst: Inst,
2959        symbol: Symbol,
2960        result: Value,
2961    ) -> Result<(), Unsupported> {
2962        let Some(indexed) = self.selector.symbols.indexed.as_ref() else {
2963            return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
2964        };
2965        let block = self.at.expect("a block is being filled");
2966        let span = self.source.span(inst);
2967        let gpr = self.gpr;
2968
2969        let slot = self.out.new_vreg(gpr);
2970        let tls_index = self.names.intern("_tls_index");
2971        let index = self.named(indexed.index);
2972        self.out.build(block, index).at(span).def(slot, gpr).mem(mir::Mem::of(tls_index)).finish();
2973
2974        let array = self.out.new_vreg(gpr);
2975        let load = self.named(indexed.load);
2976        let at = mir::Mem::in_segment(indexed.segment, indexed.at);
2977        self.out.build(block, load).at(span).def(array, gpr).mem(at).finish();
2978
2979        let copy = self.out.new_vreg(gpr);
2980        let mem =
2981            mir::Mem::at(mir::Operand::read(array, gpr)).indexed(mir::Operand::read(slot, gpr), 8);
2982        self.out.build(block, load).at(span).def(copy, gpr).mem(mem).finish();
2983
2984        let reg = self.new_reg(result);
2985        let add = self.named(indexed.add);
2986        let mem = mir::Mem::section(mir::Operand::read(copy, gpr), symbol);
2987        self.out.build(block, add).at(span).def(reg, gpr).mem(mem).finish();
2988        Ok(())
2989    }
2990
2991    /// Refuses the thread pointer where it is not written, which is Mach-O. Apple keeps it in a
2992    /// different register from the one Linux does on both machines, and nothing written for it
2993    /// has been checked on one.
2994    fn threads_written(&self, inst: Inst) -> Result<(), Unsupported> {
2995        if self.elsewhere.described() || self.elsewhere.indexed() {
2996            return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
2997        }
2998        Ok(())
2999    }
3000
3001    /// The front of this thread's block into `reg`.
3002    ///
3003    /// On x86-64 that is the one thing no instruction can work out: `%fs` is not a register a
3004    /// program can read, and what it points at is a word holding its own address, so reading
3005    /// through it at zero is how the address is come by. AArch64 keeps it in `tpidr_el0`, which
3006    /// `mrs` reads.
3007    fn read_thread_pointer(&mut self, block: mir::Block, span: Span, reg: mir::Reg) {
3008        let gpr = self.gpr;
3009        match self.selector.symbols.pointer {
3010            Pointer::Segment(name, segment) => {
3011                let load = self.named(name);
3012                let at = mir::Mem::in_segment(segment, 0);
3013                self.out.build(block, load).at(span).def(reg, gpr).mem(at).finish();
3014            }
3015            Pointer::Own(name) => {
3016                let read = self.named(name);
3017                self.out.build(block, read).at(span).def(reg, gpr).finish();
3018            }
3019        }
3020    }
3021
3022    /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
3023    /// in this same function.
3024    ///
3025    /// What the two have in common is the whole of the instruction: an address worked out from
3026    /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
3027    /// reaches anything. What they do not have in common is what fills the four bytes in. A
3028    /// global is a name, so the number is a relocation and the linker writes it. A block is a
3029    /// place in this function, so both ends are in one section and the number is known as soon as
3030    /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
3031    /// jump rather than leaving a relocation behind.
3032    ///
3033    /// Nothing here says the block is one control can arrive at. That is said by the
3034    /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
3035    /// and by nothing else: an address on its own is a number.
3036    fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
3037        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3038        let Some(call) = self.source.successors(inst).next() else {
3039            return Err(self.unsupported(inst));
3040        };
3041        let block = self.at.expect("a block is being filled");
3042        let reg = self.new_reg(result);
3043        let span = self.source.span(inst);
3044        let opcode = self.named(self.selector.jumps.near);
3045        let mem = mir::Mem::block(self.out_block(call.block));
3046        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
3047        Ok(())
3048    }
3049
3050    /// `goto *p`, GNU's computed goto, which is a jump through a register.
3051    ///
3052    /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
3053    /// block this ends, the way every other arm is, and which of them the address holds is decided
3054    /// while the program runs. So this is one instruction with one operand, and the arms are
3055    /// copied across by [`Self::edges`] like anybody else's.
3056    fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
3057        let data = &self.source[inst];
3058        let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3059        let reg = self.reg_of(address)?;
3060        let block = self.at.expect("a block is being filled");
3061        let span = self.source.span(inst);
3062        let name = self.selector.branch.indirect;
3063        let opcode = self.named(name);
3064        self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
3065        Ok(())
3066    }
3067
3068    /// A `switch` on an index from zero up, as a jump through a table of this function.
3069    ///
3070    /// Every `switch` that reaches here is one `crate::switch` left behind on purpose: it has
3071    /// already checked the value is inside the table and taken the lowest case off it, so the
3072    /// operand is a 64 bit index, the cases are the values from zero up with gaps where the
3073    /// program had no case, and the default is only where those gaps go. What is written is the
3074    /// shape gcc writes for the same statement in position independent code:
3075    ///
3076    /// ```text
3077    /// leaq    table(%rip), %base
3078    /// movslq  (%base,%index,4), %offset
3079    /// addq    %base, %offset
3080    /// jmp     *%offset
3081    /// ```
3082    ///
3083    /// The table holds distances from itself to each arm rather than addresses, which is what
3084    /// lets it be filled in by the assembler with nothing left for a linker to do. Each cell is
3085    /// stored as the place of an arm among this block's successors, which [`Self::edges`] copies
3086    /// across in the IR's own order, the default first and then one per case. See
3087    /// [`mir::Table`] for why a place and not a block.
3088    fn jump_table(&mut self, inst: Inst) -> Result<(), Unsupported> {
3089        let data = &self.source[inst];
3090        let Extra::Switch(info) = data.extra else { return Err(self.unsupported(inst)) };
3091        let &index = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3092        let ty = self.source[index].ty;
3093        if ty != Type::int(u64::BITS) {
3094            return Err(self.unsupported(inst));
3095        }
3096        let cases = self.source[self.source[info].cases].to_vec();
3097        let mut cells: Vec<u32> = Vec::new();
3098        for (arm, case) in cases.iter().enumerate() {
3099            let at = usize::try_from(case.signed(ty)).map_err(|_| self.unsupported(inst))?;
3100            if at >= cells.len() {
3101                cells.resize(at + 1, 0);
3102            }
3103            cells[at] = u32::try_from(arm + 1).map_err(|_| self.unsupported(inst))?;
3104        }
3105        let reg = self.reg_of(index)?;
3106        let block = self.at.expect("a block is being filled");
3107        let span = self.source.span(inst);
3108        let gpr = self.gpr;
3109        let table = u32::try_from(self.out.tables.len()).expect("fewer tables than that");
3110
3111        let jumps = self.selector.jumps;
3112
3113        let base = self.out.new_vreg(gpr);
3114        let near = self.named(jumps.near);
3115        self.out.build(block, near).at(span).def(base, gpr).mem(mir::Mem::table(table)).finish();
3116        let offset = self.out.new_vreg(gpr);
3117        let cell =
3118            mir::Mem::at(mir::Operand::read(base, gpr)).indexed(mir::Operand::read(reg, gpr), 4);
3119        let load = self.named(jumps.cell);
3120        self.out.build(block, load).at(span).def(offset, gpr).mem(cell).finish();
3121        // Two address on x86-64, for the reason `thread_pointer` gives.
3122        let to = self.out.new_vreg(gpr);
3123        let add = self.named(jumps.add);
3124        let written = mir::Operand::write(to, gpr);
3125        let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
3126        self.out
3127            .build(block, add)
3128            .at(span)
3129            .operand(written)
3130            .operand(mir::Operand::read(offset, gpr))
3131            .operand(mir::Operand::read(base, gpr))
3132            .finish();
3133        let jump = self.named(self.selector.branch.indirect);
3134        let jump =
3135            self.out.build(block, jump).at(span).operand(mir::Operand::read(to, gpr)).finish();
3136        self.out.tables.push(mir::Table { jump, cells });
3137        Ok(())
3138    }
3139
3140    /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
3141    /// somewhere else can bring control back here, and answers zero on the way past.
3142    ///
3143    /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
3144    /// block ends: everything after the save in the IR block is put into a new machine IR block,
3145    /// and the address of that block is what went into the buffer. That is the whole reason the
3146    /// block is split here. An address points at a label, a machine IR block is the only thing in
3147    /// this representation that has one, and a save is in the middle of a block rather than at the
3148    /// end of one.
3149    ///
3150    /// # How the answer gets back
3151    ///
3152    /// Through the frame rather than through a register. The save writes a zero into a word of its
3153    /// own frame, puts the address of that word in the buffer, and the new block reads the word
3154    /// back. The restore writes a one through the address it finds in the buffer before it goes.
3155    /// So one load answers zero on the way past and one on the way back, and neither path has to
3156    /// agree with the other about a register.
3157    ///
3158    /// gcc does it the other way round, with a second block that sets the answer to one and is
3159    /// what the restore arrives at. That block is one nothing in the function jumps to, and a
3160    /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
3161    /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
3162    /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
3163    /// and it needs nothing said anywhere about a block arrived at from outside.
3164    ///
3165    /// # What the allocator is told
3166    ///
3167    /// That every register it hands out is gone at the end of the first block. That is what makes
3168    /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
3169    /// in some other function, and the only two registers that puts back are the stack pointer and
3170    /// the frame pointer, so anything this function still wants has to be in the frame those two
3171    /// reach. It is said with a write of every one of those registers, which is the same thing a
3172    /// call says about the registers a callee may destroy, on an instruction with nothing else on
3173    /// it so that the stores above are not caught up in it.
3174    fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
3175        let data = &self.source[inst];
3176        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3177        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3178        let span = self.source.span(inst);
3179        let buf = self.reg_of(buffer)?;
3180        let at = self.at.expect("a block is being filled");
3181        let gpr = self.gpr;
3182        let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3183        let store = self.named(moves.store);
3184        let load = self.named(moves.load);
3185        let lea = self.named(self.selector.frame.lea);
3186        let put = self.named(self.selector.frame.imm);
3187        let nothing =
3188            self.selector.frame.pad.expect("a target with an instruction that does nothing");
3189        let nothing = self.named(nothing);
3190        self.stack.saves_place = true;
3191        let answer = self.answer_slot();
3192        let back = self.out.create_block();
3193
3194        // The zero this answers with, into the word a restore writes a one into.
3195        let zero = self.out.new_vreg(gpr);
3196        self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
3197        let mem = self.frame_mem();
3198        let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
3199        self.stack.addresses.push((made, answer));
3200
3201        // The four words: where that word is, where control comes back to, and the two registers
3202        // the restore puts back.
3203        let found = self.frame_address(at, answer);
3204        self.write_word(at, span, store, found, buf, JUMP_ANSWER);
3205        let pc = self.out.new_vreg(gpr);
3206        self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
3207        self.write_word(at, span, store, pc, buf, JUMP_PC);
3208        let frame = mir::Reg::physical(self.conv.frame_pointer);
3209        self.write_word(at, span, store, frame, buf, JUMP_FRAME);
3210        let stack = mir::Reg::physical(self.conv.stack_pointer);
3211        self.write_word(at, span, store, stack, buf, JUMP_STACK);
3212
3213        // Nothing is in a register past this point, which is what the rest of the function is
3214        // allowed to assume about the way back in.
3215        let gone = self.across_jump();
3216        let mut build = self.out.build(at, nothing).at(span);
3217        for (reg, class) in gone {
3218            build = build.operand(mir::Operand::write(reg, class));
3219        }
3220        build.finish();
3221
3222        // And the rest of the block, which is the block the address above was of.
3223        *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
3224        self.at = Some(back);
3225        let reg = self.new_reg(result);
3226        let mem = self.frame_mem();
3227        let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
3228        self.stack.addresses.push((made, answer));
3229        Ok(())
3230    }
3231
3232    /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
3233    ///
3234    /// Everything comes out of the buffer before anything is put back, and the four registers it
3235    /// comes out into are physical ones rather than values the allocator places. Both of those are
3236    /// about the same moment. The stack pointer is one of the things being put back, a value the
3237    /// allocator sent to the stack is reached through the stack pointer, and between the
3238    /// instruction that moves it and the jump there is no stack this function owns any more. A
3239    /// register named outright is a register nothing reloads into and nothing else is in, which is
3240    /// the only way to hold something across that moment.
3241    ///
3242    /// Four of them because that is how many things are in the air at once: where to go, the frame
3243    /// pointer to put back, the one the matching save is to answer with, and one register used
3244    /// twice, first for the address that one is written through and then for the stack pointer.
3245    ///
3246    /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
3247    /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
3248    /// written out and never run.
3249    fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
3250        let data = &self.source[inst];
3251        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3252        let span = self.source.span(inst);
3253        let buf = self.reg_of(buffer)?;
3254        let at = self.at.expect("a block is being filled");
3255        let gpr = self.gpr;
3256        let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3257        let load = self.named(moves.load);
3258        let store = self.named(moves.store);
3259        let mov = self.named(moves.mov);
3260        let put = self.named(self.selector.frame.imm);
3261        let jump = self.named(self.selector.branch.indirect);
3262
3263        let held = self.jump_regs();
3264        if held.len() < JUMP_REGS {
3265            return Err(self.unsupported(inst));
3266        }
3267        let pc = mir::Reg::physical(held[0]);
3268        let frame = mir::Reg::physical(held[1]);
3269        let spare = mir::Reg::physical(held[2]);
3270        let one = mir::Reg::physical(held[3]);
3271
3272        self.read_word(at, span, load, pc, buf, JUMP_PC);
3273        self.read_word(at, span, load, frame, buf, JUMP_FRAME);
3274        self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
3275
3276        // What the matching save answers with, written through the address that came out of the
3277        // buffer, because the word it goes in is in the other function's frame and this one has no
3278        // way of knowing where that is.
3279        self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
3280        let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
3281        self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
3282
3283        // The stack last of the four, so that the register the buffer is reached through is done
3284        // with before the stack it may have been spilled to stops being this function's.
3285        self.read_word(at, span, load, spare, buf, JUMP_STACK);
3286        let stack = mir::Reg::physical(self.conv.stack_pointer);
3287        self.copy(at, span, mov, stack, spare);
3288        let base = mir::Reg::physical(self.conv.frame_pointer);
3289        self.copy(at, span, mov, base, frame);
3290
3291        // And the jump, which reads the two registers just put back as well as the address it
3292        // goes through. Neither of those is printed, because the target's spelling of an indirect
3293        // jump has one argument and it is the first one read. They are there because the code
3294        // control arrives at reaches its frame through them, and because without them the two
3295        // instructions above write registers nothing reads: a scheduler is then free to put the
3296        // jump in front of them, and at `-O2` it does.
3297        self.out
3298            .build(at, jump)
3299            .at(span)
3300            .operand(mir::Operand::read(pc, gpr))
3301            .operand(mir::Operand::read(stack, gpr))
3302            .operand(mir::Operand::read(base, gpr))
3303            .finish();
3304        Ok(())
3305    }
3306
3307    /// One word of the buffer of a `__builtin_setjmp`, written from a register.
3308    fn write_word(
3309        &mut self,
3310        at: mir::Block,
3311        span: Span,
3312        store: mir::Opcode,
3313        from: mir::Reg,
3314        buf: mir::Reg,
3315        word: i32,
3316    ) {
3317        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3318        self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
3319    }
3320
3321    /// One word of that buffer, read back into a register.
3322    fn read_word(
3323        &mut self,
3324        at: mir::Block,
3325        span: Span,
3326        load: mir::Opcode,
3327        into: mir::Reg,
3328        buf: mir::Reg,
3329        word: i32,
3330    ) {
3331        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3332        self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
3333    }
3334
3335    /// One register into another, which is the one shape of instruction the builder has no word
3336    /// for because neither operand is a definition of a value or a read of memory.
3337    fn copy(
3338        &mut self,
3339        at: mir::Block,
3340        span: Span,
3341        mov: mir::Opcode,
3342        into: mir::Reg,
3343        from: mir::Reg,
3344    ) {
3345        self.out
3346            .build(at, mov)
3347            .at(span)
3348            .operand(mir::Operand::write(into, self.gpr))
3349            .operand(mir::Operand::read(from, self.gpr))
3350            .finish();
3351    }
3352
3353    /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
3354    fn answer_slot(&mut self) -> usize {
3355        match self.answer {
3356            Some(index) => index,
3357            None => {
3358                let index = self.stack.locals.len();
3359                self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
3360                self.answer = Some(index);
3361                index
3362            }
3363        }
3364    }
3365
3366    /// An address in this function's frame with nothing in its displacement, which is what an
3367    /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
3368    /// where the object is.
3369    fn frame_mem(&self) -> mir::Mem {
3370        mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
3371    }
3372
3373    /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
3374    ///
3375    /// Both files, since a `double` live across a save has the same problem an integer does. The
3376    /// two registers a frame is reached through are not here: the restore puts both of them back,
3377    /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
3378    /// by its own save would have nothing left to find its caller with.
3379    fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
3380        let mut gone = Vec::new();
3381        for &reg in self.conv.int_order {
3382            if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
3383                continue;
3384            }
3385            gone.push((mir::Reg::physical(reg), self.gpr));
3386        }
3387        for &reg in self.conv.sse_order {
3388            gone.push((mir::Reg::physical(reg), self.conv.sse_class));
3389        }
3390        gone
3391    }
3392
3393    /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
3394    ///
3395    /// The ones the allocator hands out, less the two a frame is reached through. The scratch
3396    /// registers are not among them on purpose: the rewriter writes a reload into one of those
3397    /// wherever it likes, and one of these has to survive from the load that fills it to the
3398    /// instruction that reads it however many instructions apart those are.
3399    fn jump_regs(&self) -> Vec<PhysReg> {
3400        self.conv
3401            .int_order
3402            .iter()
3403            .copied()
3404            .filter(|&reg| {
3405                reg != self.conv.stack_pointer
3406                    && reg != self.conv.frame_pointer
3407                    && !self.selector.scratch.contains(&reg)
3408            })
3409            .collect()
3410    }
3411
3412    /// A machine opcode of this target from the name the target gives it.
3413    fn named(&mut self, name: &str) -> mir::Opcode {
3414        mir::Opcode::new(self.names.intern(&format!("{}{name}", self.selector.prefix())))
3415    }
3416
3417    /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
3418    /// saved frame pointers and then one thing read at the end of it.
3419    ///
3420    /// Every frame that kept a frame pointer holds the caller's at the address the register points
3421    /// at, and the address that frame returns to one word above that, which is where the call
3422    /// instruction put it and where the prologue's push left it. So the walk is a load through the
3423    /// register for each link, the frame address is wherever the walk stopped, and the return
3424    /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
3425    /// x86-64 at `-O2` for depths zero to three of both builtins.
3426    ///
3427    /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
3428    /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
3429    /// needs it as the start, so there is no case here where it is not wanted.
3430    ///
3431    /// How far the chain actually reaches is the program's business and not this one's. A caller
3432    /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
3433    /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
3434    /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
3435    /// `check/builtin/frame.rs` rather than walked as far as it says.
3436    fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
3437        let data = &self.source[inst];
3438        let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
3439        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3440        let returning = data.opcode == Opcode::ReturnAddress;
3441        let block = self.at.expect("a block is being filled");
3442        let span = self.source.span(inst);
3443        let moves =
3444            self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
3445        let load = self.named(moves.load);
3446        self.stack.walks_frames = true;
3447
3448        // Where the walk is up to. The frame pointer to begin with, and the register the last load
3449        // wrote after that.
3450        let reg = self.new_reg(result);
3451        let mut base = mir::Reg::physical(self.conv.frame_pointer);
3452        for link in 0..depth {
3453            // The last load of a walk that is looking for a frame writes the answer itself, which
3454            // is what keeps a walk of so many links that many instructions and not one more.
3455            let ends_here = link + 1 == depth && !returning;
3456            let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
3457            let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
3458            self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
3459            base = next;
3460        }
3461
3462        if returning {
3463            let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
3464            let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
3465            self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
3466        } else if depth == 0 {
3467            // The one case with no load in it at all: the frame this function is running in is the
3468            // register itself, and a physical register is not one the allocator hands out, so the
3469            // answer is a copy of it.
3470            let mov = self.named(moves.mov);
3471            self.out
3472                .build(block, mov)
3473                .at(span)
3474                .operand(mir::Operand::write(reg, self.gpr))
3475                .operand(mir::Operand::read(base, self.gpr))
3476                .finish();
3477        }
3478        Ok(())
3479    }
3480
3481    /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
3482    /// an offset to.
3483    ///
3484    /// The same one instruction, on its own this time and with nothing to add to it. A program
3485    /// writes this when what it wants is a number that is different in every thread and cheap to
3486    /// come by, rather than a variable of its own in the block, so there is no relocation here and
3487    /// no name for the link to resolve.
3488    fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
3489        self.threads_written(inst)?;
3490        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3491        let block = self.at.expect("a block is being filled");
3492        let span = self.source.span(inst);
3493        let reg = self.new_reg(result);
3494        self.read_thread_pointer(block, span, reg);
3495        Ok(())
3496    }
3497
3498    /// What a named machine register holds, which is `register long x asm ("rbx");`.
3499    ///
3500    /// One move out of that register, with the register named as itself the way a register a
3501    /// template wrote is named, which is [`Self::itself`] and is the thing #1653 built. What it
3502    /// buys here is what it buys there: the register is part of the instruction the allocator
3503    /// sees, so it is a use the allocator will not have written over first, and the value goes
3504    /// into an ordinary one of its own that everything downstream reads.
3505    ///
3506    /// The whole sixty four bits are moved whatever the type is, because the register is that
3507    /// wide and a narrower type reads the low end of the copy, which is the same low end. A type
3508    /// wider than the register is refused, since there is no register holding it to read. On
3509    /// AArch64 a float may be kept in a vector register, `register double x asm ("d8");`, and it is
3510    /// moved out of that file the same way.
3511    ///
3512    /// A name the machine has not got is refused too, and is the only thing that can be wrong
3513    /// with the string: which register a name means is this machine's question and this is where
3514    /// the question is asked, at the same table `asm` asks about clobbers at. The sigil gcc
3515    /// allows in front of it is taken off here, because what the name is written with is syntax.
3516    fn register_value(&mut self, inst: Inst) -> Result<(), Unsupported> {
3517        let Extra::Symbol(symbol) = self.source[inst].extra else {
3518            return Err(self.unsupported(inst));
3519        };
3520        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3521        let ty = self.source[result].ty;
3522        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3523        if bits > ADDRESS_BITS {
3524            return Err(self.unsupported(inst));
3525        }
3526        let spelled = self.names.resolve(symbol).to_owned();
3527        let bare = spelled.strip_prefix('%').unwrap_or(&spelled);
3528        let named = if self.on_aarch64() {
3529            aarch64::named(bare)
3530        } else if self.class_of(ty) != self.gpr {
3531            return Err(self.unsupported(inst));
3532        } else {
3533            x86_64::gpr_named(bare).map(|(reg, _)| (reg, self.gpr))
3534        };
3535        let Some((held, file)) = named else {
3536            return Err(Unsupported::Register { inst, name: spelled });
3537        };
3538        // A float in a general purpose register, or a number in a vector one, is a register the
3539        // machine has holding a type that is not kept there, and would need a move between the
3540        // files that nothing here makes yet.
3541        if on_x87(ty) || self.class_of(ty) != file {
3542            return Err(self.unsupported(inst));
3543        }
3544        let block = self.at.expect("a block is being filled");
3545        let span = self.source.span(inst);
3546        let mov = self.selector.frame.moves(file).expect("a class the target says how to move").mov;
3547        let mov = self.named(mov);
3548        let into = self.new_reg(result);
3549        self.out
3550            .build(block, mov)
3551            .at(span)
3552            .operand(mir::Operand::write(into, file))
3553            .operand(
3554                mir::Operand::read(mir::Reg::physical(held), file).with(Constraint::Fixed(held)),
3555            )
3556            .finish();
3557        Ok(())
3558    }
3559
3560    /// A conversion that converts nothing: the result is the operand under another type.
3561    ///
3562    /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
3563    /// an integer as wide as the machine addresses, so a cast between the two changes what the
3564    /// type system calls the value and changes nothing about the value, and the register holding
3565    /// it is the register that already held it. The front end never writes either of them at any
3566    /// other width, because it widens or narrows around the cast rather than through it, so the
3567    /// two widths disagreeing here means the IR came from somewhere else and is refused rather
3568    /// than guessed at.
3569    ///
3570    /// Reading the operand first is what materializes it when it is a constant, which is the case
3571    /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
3572    /// register before anything can call it an address.
3573    fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
3574        let data = &self.source[inst];
3575        let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
3576        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3577        if !self.is_address_width(self.source[arg].ty)
3578            || !self.is_address_width(self.source[result].ty)
3579        {
3580            return Err(self.unsupported(inst));
3581        }
3582        let reg = self.reg_of(arg)?;
3583        self.regs[result.index()] = Some(reg);
3584        Ok(())
3585    }
3586
3587    /// One barrier, which on this machine is one instruction at the strongest ordering and no
3588    /// instruction at all at every other one.
3589    ///
3590    /// x86-64 is total store order, so the only reordering the machine does is a store followed by
3591    /// a load of a different address, and the only ordering that forbids that is sequential
3592    /// consistency. An acquire, a release and an acquire release fence are therefore already true
3593    /// of every program running here, and what a program wanted from writing one is that the
3594    /// compiler not move memory accesses across it. The optimizer has finished by the time this
3595    /// runs and nothing below reorders one access past another, so the constraint is already
3596    /// discharged and there is nothing to write.
3597    ///
3598    /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
3599    /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
3600    /// on the stack is faster on most parts and is what some compilers write instead; it is also a
3601    /// write to memory the program did not ask for, and the plain barrier is the one that says what
3602    /// it means.
3603    ///
3604    /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
3605    /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
3606    /// nothing, so there is no equality to state, and what makes it the right answer is the memory
3607    /// model, which the rule language cannot talk about.
3608    fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
3609        let Extra::Order(order) = self.source[inst].extra else {
3610            return Err(self.unsupported(inst));
3611        };
3612        // AArch64 is not total store order, so every ordering above relaxed is an instruction
3613        // there. An acquire fence only has to keep later accesses after earlier loads, which is
3614        // `dmb ishld`, and everything stronger is the full `dmb ish` gcc writes for it.
3615        let name = match order {
3616            MemOrder::NotAtomic | MemOrder::Relaxed => return Ok(()),
3617            MemOrder::Acquire if self.on_aarch64() => "fence_acquire",
3618            _ if self.on_aarch64() => self.selector.fence,
3619            MemOrder::SeqCst => self.selector.fence,
3620            _ => return Ok(()),
3621        };
3622        let block = self.at.expect("a block is being filled");
3623        let span = self.source.span(inst);
3624        let fence = self.named(name);
3625        self.out.build(block, fence).at(span).finish();
3626        Ok(())
3627    }
3628
3629    /// The instruction a program stops on, which is one byte pair and no operands.
3630    ///
3631    /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
3632    /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
3633    /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
3634    /// caught by anything the program installed for an ordinary error, cannot be returned from,
3635    /// and leaves the address of the fault in the core file.
3636    ///
3637    /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
3638    /// library, and it works in the places this one is written most, which are a kernel and a
3639    /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
3640    fn trap(&mut self, inst: Inst) {
3641        let block = self.at.expect("a block is being filled");
3642        let span = self.source.span(inst);
3643        let stop = self.named(self.selector.trap);
3644        self.out.build(block, stop).at(span).finish();
3645    }
3646
3647    /// One hint that an address is about to be used, which is one instruction and no promise.
3648    ///
3649    /// Four instructions on this machine and the locality picks between them, which is what the
3650    /// number means: how much of the data will still be wanted after the access. None of it wanted
3651    /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
3652    /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
3653    /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
3654    /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
3655    ///
3656    /// Whether the access will write is not read on x86-64, and that is the machine rather than an
3657    /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
3658    /// writes it only when the command line said the part has it. So a prefetch for a write is the
3659    /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
3660    /// `-mprfchw`. AArch64 has it in the base set, so there a write picks the four `pst` forms of
3661    /// `prfm` in place of the `pld` ones, at the same levels.
3662    ///
3663    /// The address goes in the addressing mode rather than in an operand, the way a store's does.
3664    /// It is built here as the plainest one there is, a register and nothing else, because what
3665    /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
3666    /// this instruction. An address the program computed is therefore one `lea` or one add in front
3667    /// of this, which is what it would have been for the load the hint is about anyway.
3668    fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
3669        let Extra::Prefetch(hint) = self.source[inst].extra else {
3670            return Err(self.unsupported(inst));
3671        };
3672        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3673        let [address] = args[..] else { return Err(self.unsupported(inst)) };
3674        // AArch64 has the write hint in the base instruction set, and gcc 16.2.0 writes it there.
3675        let write = hint.write && self.on_aarch64();
3676        let name = match (hint.locality, write) {
3677            (0, false) => "prefetch_nta",
3678            (1, false) => "prefetch_t2",
3679            (2, false) => "prefetch_t1",
3680            (PrefetchHint::MOST, false) => "prefetch_t0",
3681            (0, true) => "prefetch_w_nta",
3682            (1, true) => "prefetch_w_t2",
3683            (2, true) => "prefetch_w_t1",
3684            (PrefetchHint::MOST, true) => "prefetch_w_t0",
3685            // Nothing else exists. The checker reads a locality outside the range as zero and the
3686            // verifier refuses one that got here another way, so this is a hint that was built
3687            // rather than checked, and the safe answer for a hint is to write no instruction.
3688            _ => return Err(self.unsupported(inst)),
3689        };
3690        let base = self.reg_of(address)?;
3691        let block = self.at.expect("a block is being filled");
3692        let opcode = self.named(name);
3693        self.out
3694            .build(block, opcode)
3695            .at(self.source.span(inst))
3696            .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
3697            .finish();
3698        Ok(())
3699    }
3700
3701    /// One compare and exchange, which is the instruction every other atomic on this machine is
3702    /// built out of.
3703    ///
3704    /// What the IR asks for is: read what is at an address, compare it against a value the program
3705    /// expected, put a second value there if the two were equal, and say both what was read and
3706    /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
3707    /// front of it is what makes the whole of it one step as far as every other processor is
3708    /// concerned.
3709    ///
3710    /// The ordering is not read here, and that is the memory model rather than an omission. A
3711    /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
3712    /// compare and exchange and a sequentially consistent one are the same instruction, and there
3713    /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
3714    /// same reason.
3715    ///
3716    /// The two values it produces are why this is written by name. The one the program compares
3717    /// against and the one it gets back are both `rax`, which the instruction reads and writes
3718    /// without being told, and the table says so with a fixed constraint at each end rather than
3719    /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
3720    /// flag read out by a `sete`, and it is a definition of the same instruction so that the
3721    /// allocator knows the two are live together and never gives the byte the register the answer
3722    /// is in.
3723    fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
3724        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3725        let results: Vec<Value> = self.source[inst].results().collect();
3726        let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
3727        let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
3728        if self.on_aarch64() {
3729            return self.exchange_a64(inst, [addr, expected, desired], [old, exchanged]);
3730        }
3731
3732        // A value the machine can compare in one instruction, which is an integer or an address at
3733        // one of the four widths it has a compare and exchange for. Anything else is a type this
3734        // has no instruction for rather than a program that is wrong, and the front end refuses it
3735        // before ever getting here.
3736        let ty = self.source[old].ty;
3737        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3738        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3739            return Err(self.unsupported(inst));
3740        }
3741
3742        let base = self.reg_of(addr)?;
3743        let want = self.reg_of(expected)?;
3744        let put = self.reg_of(desired)?;
3745        let got = self.new_reg(old);
3746        let flag = self.new_reg(exchanged);
3747
3748        let name = format!("cmpxchg_{bits}");
3749        let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3750        let block = self.at.expect("a block is being filled");
3751        let opcode = self.named(&name);
3752        let (span, flags) = (self.source.span(inst), self.carried(inst));
3753        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3754        for (desc, reg) in descs.iter().zip([got, flag, want, put]) {
3755            let operand = mir::Operand {
3756                reg,
3757                class: desc.class,
3758                role: desc.role,
3759                constraint: desc.constraint,
3760            };
3761            build = build.operand(operand);
3762        }
3763        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3764        Ok(())
3765    }
3766
3767    /// One read modify write, for the three operations this machine does in a single instruction.
3768    ///
3769    /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
3770    /// say what was there before, and let nothing get between the three steps. The machine has
3771    /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
3772    /// found in the register the operand arrived in, which is why the value that comes back and the
3773    /// value that went in are one register here.
3774    ///
3775    /// A subtraction is the add over the negated operand, which is right at every width because the
3776    /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
3777    /// whatever the operands were. The negate is a separate instruction in front, over a register of
3778    /// its own, so that the value the program handed over is not the one written on: an operand may
3779    /// be live after this and a program that read it again would read the negation.
3780    ///
3781    /// The ordering is not read, for the reason the compare and exchange beside this does not read
3782    /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
3783    /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
3784    ///
3785    /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
3786    /// around a compare and exchange before anything here saw it. The two that do arrive are the
3787    /// ones on floating values, and they are refused: a compare and exchange of a float wants the
3788    /// value carried through an integer of the same width, and an eighty bit float has no such
3789    /// width. Neither family of builtins can write one yet either, so a program that reaches this
3790    /// refusal is a program that reached an unimplemented builtin first.
3791    fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
3792        let Extra::Rmw(op, _) = self.source[inst].extra else {
3793            return Err(self.unsupported(inst));
3794        };
3795        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3796        let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
3797        let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3798
3799        // A value the machine can exchange in one instruction, which is an integer at one of the
3800        // four widths it has these for. A pointer arrives as an address, so it is an integer by the
3801        // time it is here, and anything else is a type this has no instruction for.
3802        let ty = self.source[old].ty;
3803        if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3804            return Err(self.unsupported(inst));
3805        }
3806        if self.on_aarch64() {
3807            return self.modify_a64(inst, op, [addr, operand], old);
3808        }
3809        let name = match op {
3810            RmwOp::Xchg => format!("xchg_{}", ty.bits()),
3811            RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
3812            _ => return Err(self.unsupported(inst)),
3813        };
3814
3815        let base = self.reg_of(addr)?;
3816        let mut put = self.reg_of(operand)?;
3817        let block = self.at.expect("a block is being filled");
3818        let span = self.source.span(inst);
3819        if op == RmwOp::Sub {
3820            let negated = self.out.new_vreg(self.gpr);
3821            let negate = self.named(&format!("neg_r_{}", ty.bits()));
3822            let descs = self
3823                .selector
3824                .operands(&format!("neg_r_{}", ty.bits()))
3825                .ok_or_else(|| self.unsupported(inst))?;
3826            let mut build = self.out.build(block, negate).at(span);
3827            for (desc, reg) in descs.iter().zip([negated, put]) {
3828                build = build.operand(mir::Operand {
3829                    reg,
3830                    class: desc.class,
3831                    role: desc.role,
3832                    constraint: desc.constraint,
3833                });
3834            }
3835            build.finish();
3836            put = negated;
3837        }
3838
3839        let got = self.new_reg(old);
3840        let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3841        let opcode = self.named(&name);
3842        let flags = self.carried(inst);
3843        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3844        for (desc, reg) in descs.iter().zip([got, put]) {
3845            build = build.operand(mir::Operand {
3846                reg,
3847                class: desc.class,
3848                role: desc.role,
3849                constraint: desc.constraint,
3850            });
3851        }
3852        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3853        Ok(())
3854    }
3855
3856    /// The width an AArch64 atomic works at, which is an integer or an address of one of the four
3857    /// widths the exclusive loads and stores have. Anything else is refused.
3858    fn atomic_bits(&self, inst: Inst, ty: Type) -> Result<u32, Unsupported> {
3859        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3860        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3861            return Err(self.unsupported(inst));
3862        }
3863        Ok(bits)
3864    }
3865
3866    /// One instruction by name, with its operands in the order the table lists them.
3867    fn written_as(&mut self, inst: Inst, name: &str, regs: &[mir::Reg]) -> Result<(), Unsupported> {
3868        let descs = self.selector.operands(name).ok_or_else(|| self.unsupported(inst))?;
3869        if descs.len() != regs.len() {
3870            return Err(self.unsupported(inst));
3871        }
3872        let block = self.at.expect("a block is being filled");
3873        let opcode = self.named(name);
3874        let (span, flags) = (self.source.span(inst), self.carried(inst));
3875        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3876        for (desc, &reg) in descs.iter().zip(regs) {
3877            build = build.operand(mir::Operand {
3878                reg,
3879                class: desc.class,
3880                role: desc.role,
3881                constraint: desc.constraint,
3882            });
3883        }
3884        build.finish();
3885        Ok(())
3886    }
3887
3888    /// An acquiring load or a releasing store on AArch64, which is `ldar` or `stlr`.
3889    ///
3890    /// Only a relaxed access became the plain one above this, so what arrives is acquire or
3891    /// stronger for a load and release or stronger for a store. `ldar` and `stlr` are also
3892    /// sequentially consistent with each other, which is why the strongest ordering needs no fence
3893    /// on either side, and is what gcc 16.2.0 writes for all of them.
3894    fn ordered(&mut self, inst: Inst) -> Result<(), Unsupported> {
3895        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3896        if self.source[inst].opcode == Opcode::AtomicLoad {
3897            let [addr] = args[..] else { return Err(self.unsupported(inst)) };
3898            let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3899            let bits = self.atomic_bits(inst, self.source[result].ty)?;
3900            let base = self.reg_of(addr)?;
3901            let got = self.new_reg(result);
3902            return self.written_as(inst, &format!("ldar_{bits}"), &[got, base]);
3903        }
3904        let [value, addr] = args[..] else { return Err(self.unsupported(inst)) };
3905        let bits = self.atomic_bits(inst, self.source[value].ty)?;
3906        let put = self.reg_of(value)?;
3907        let base = self.reg_of(addr)?;
3908        self.written_as(inst, &format!("stlr_{bits}"), &[put, base])
3909    }
3910
3911    /// A compare and exchange on AArch64, which is a loop of an exclusive load and store.
3912    ///
3913    /// The loop is one instruction as far as everything below is concerned, so that nothing can
3914    /// be spilled or reloaded between the two exclusive accesses, which would lose the reservation
3915    /// on some parts every time. Its definitions are all early, since they are written before the
3916    /// last read. The acquiring and releasing forms are used whatever the ordering, which is what
3917    /// gcc writes at the strongest one and is never wrong at a weaker one. The yes or no comes out
3918    /// of the status register the store wrote, read as a flag after the loop.
3919    fn exchange_a64(
3920        &mut self,
3921        inst: Inst,
3922        [addr, expected, desired]: [Value; 3],
3923        [old, exchanged]: [Value; 2],
3924    ) -> Result<(), Unsupported> {
3925        let bits = self.atomic_bits(inst, self.source[old].ty)?;
3926        let base = self.reg_of(addr)?;
3927        let want = self.reg_of(expected)?;
3928        let put = self.reg_of(desired)?;
3929        let got = self.new_reg(old);
3930        let flag = self.new_reg(exchanged);
3931        self.written_as(inst, &format!("cmpxchg_{bits}"), &[got, flag, base, want, put])
3932    }
3933
3934    /// A read modify write on AArch64, for the three operations that reach here, each a loop of
3935    /// an exclusive load and store for the reason the compare and exchange above is.
3936    fn modify_a64(
3937        &mut self,
3938        inst: Inst,
3939        op: RmwOp,
3940        [addr, operand]: [Value; 2],
3941        old: Value,
3942    ) -> Result<(), Unsupported> {
3943        let bits = self.atomic_bits(inst, self.source[old].ty)?;
3944        let base = self.reg_of(addr)?;
3945        let put = self.reg_of(operand)?;
3946        let got = self.new_reg(old);
3947        let status = self.out.new_vreg(self.gpr);
3948        match op {
3949            RmwOp::Xchg => {
3950                self.written_as(inst, &format!("xchg_{bits}"), &[got, status, base, put])
3951            }
3952            RmwOp::Add | RmwOp::Sub => {
3953                let name = if op == RmwOp::Add { "xadd" } else { "xsub" };
3954                let new = self.out.new_vreg(self.gpr);
3955                self.written_as(inst, &format!("{name}_{bits}"), &[got, new, status, base, put])
3956            }
3957            _ => Err(self.unsupported(inst)),
3958        }
3959    }
3960
3961    /// One `asm` statement.
3962    ///
3963    /// An empty template is most of the inline assembly in a test suite, and it is not a corner
3964    /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
3965    /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
3966    /// years of bug reports about optimizers are full of them. What such a statement asks for is
3967    /// the barrier and the operand places, and no instructions at all.
3968    ///
3969    /// So the operands are the half that is always real: a constraint says where a value has to be,
3970    /// and where it has to be is still true when the template between them is empty.
3971    ///
3972    /// What the constraints ask for, on an empty template, is only ever that two operands share a
3973    /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
3974    /// no particular one, and any register at all answers it. A matching constraint is different,
3975    /// because it says the output the assembly leaves is the place the input arrived in, and with
3976    /// no instructions between them that is the input unchanged. So it is a rename and not a move:
3977    /// the value is already in a register and the result is that register.
3978    ///
3979    /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
3980    /// which for a template that writes nothing is whatever was in the register. That is a value
3981    /// the program is not entitled to, and this writes a zero rather than reading one, because the
3982    /// allocator has to be given a definition before a use whatever the program is entitled to.
3983    ///
3984    /// # A template with instructions in it
3985    ///
3986    /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
3987    /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
3988    /// instruction a program wrote is looked up in that description rather than copied through to
3989    /// an assembler that has one of its own. So nothing here assembles anything. What it does is
3990    /// put the statement's operands where the opcode holds them, and from there an `asm` statement
3991    /// is ordinary machine code: the allocator picks the registers, the listing and the object file
3992    /// are written from the same table as every other instruction, and a spill around one works
3993    /// because there is nothing left about it for a spill to get wrong.
3994    ///
3995    /// A register the template named in its own text is the one thing in there that is nobody's
3996    /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
3997    /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
3998    ///
3999    /// Two things are refused, both for one reason, which is that placing them by a guess gives a
4000    /// program that assembles into something other than what it says.
4001    ///
4002    /// An output the template writes more than once, which is one place with two definitions in it,
4003    /// and the machine IR between here and the allocator has one definition per register by
4004    /// construction. An output tied to an input and written once is not that: it is two registers
4005    /// the description ties together, which is what [`Place`] is about.
4006    ///
4007    /// An operand read where the opcode writes, or written where it reads. An output that has not
4008    /// been written yet is not a value, and an input the assembly writes over is a value something
4009    /// else may still be using.
4010    ///
4011    /// # A register the instruction uses without being told
4012    ///
4013    /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
4014    /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
4015    /// registers. The description holds every bit of that already, so what is left is to say which
4016    /// of the statement's operands is in each of those registers, and the constraint letter is the
4017    /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
4018    /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
4019    /// and has no choice about it.
4020    ///
4021    /// A register no letter named is one the statement put nothing in, and that is the usual case
4022    /// rather than an unusual one, since an instruction that answers four questions is written by
4023    /// programs that asked one. A write of one is the register being destroyed and gets a register
4024    /// of its own, which is what tells the allocator to keep everything else out of it. A read of
4025    /// one is a register the instruction looks at and the program never filled, which gets a zero
4026    /// for the reason [`Self::undefined`] gives.
4027    ///
4028    /// # The clobber list
4029    ///
4030    /// Read now, as the registers it names being written by every instruction of the template. By
4031    /// every one rather than by one of them, because the list says the assembly as a whole leaves
4032    /// them ruined and nothing here knows which line did it. Every entry has to be a register this
4033    /// machine has a name for or the statement is refused, since a name nobody read is a register
4034    /// nobody is keeping out of.
4035    ///
4036    /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
4037    /// says the assembly touches storage, which is already true of every `asm` this writes and is
4038    /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
4039    /// tracking already has that from the instructions the template was read into, since it takes
4040    /// every instruction it does not recognize as writing them and every instruction here is one
4041    /// this machine describes. `flags` is the name gcc's own register table gives the same thing on
4042    /// this machine, so a program writing it has written `cc` and is read that way: tcc's
4043    /// `tests/tcctest.c` lists both on one statement.
4044    ///
4045    /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
4046    /// by description, and a statement listing three of them as clobbers as well is saying the
4047    /// same thing twice, which the allocator would read as one register with two definitions.
4048    ///
4049    /// On a template with nothing in it the list is ignored, as it was before, since a template
4050    /// with no instructions ruins nothing whatever it said about what it ruins.
4051    fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
4052        let data = &self.source[inst];
4053        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4054        let info = self.source[asm];
4055        if self.jumps_from_text(inst) {
4056            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
4057        }
4058        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4059
4060        let constraints = self.names.resolve(info.constraints).to_string();
4061        let results: Vec<Value> = data.results().collect();
4062        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
4063            .ok_or_else(refused)?;
4064        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
4065
4066        // Read after the constraints and not before them, because a mnemonic whose suffix the
4067        // program left off is read at the width of the operands it names, and the operands are
4068        // what the constraints are a list of.
4069        let widths: Vec<Option<x86_64::Width>> = list
4070            .iter()
4071            .map(|operand| {
4072                let ty = self.source[operand.result.or(operand.value)?].ty;
4073                if !ty.is_scalar() {
4074                    return None;
4075                }
4076                x86_64::Width::of_bits(held_bits(ty))
4077            })
4078            .collect();
4079        // An operand in memory is an address the statement holds and an object the template names,
4080        // so the reader is told which ones those are and spells `%0` for one as the object.
4081        let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
4082        let template = self.names.resolve(info.template).to_string();
4083        // A clobber list naming a vector register goes the way a template this cannot read does.
4084        // The instructions read here are all in the general purpose file, and what keeps the text
4085        // already takes every vector register a call may use away from the allocator across it.
4086        let clobbers = self.names.resolve(info.clobbers);
4087        if clobbers.split(',').any(|entry| vector_named(entry).is_some()) {
4088            return self.kept(inst, &template, &list, &widths, &memory);
4089        }
4090        let steps = if template.trim().is_empty() {
4091            Vec::new()
4092        } else {
4093            match x86_64::read_in(&template, &widths, &memory) {
4094                Some(steps) => steps,
4095                None => return self.kept(inst, &template, &list, &widths, &memory),
4096            }
4097        };
4098
4099        // Which operands the template writes, counted before anything is placed, because the answer
4100        // decides where each of the three below comes from and one instruction may name an operand
4101        // that a later one writes. Which of them any instruction puts in a register at all is
4102        // counted in the same walk, since an operand no instruction reaches that way is one nothing
4103        // has to put anywhere: a constant a template names only as the distance into an address is
4104        // written into the instruction, and a register holding a copy of it would be one nobody
4105        // reads. An operand the address is counted from is reached that way and is counted here for
4106        // that reason, because the walk below it is over the opcode's operands and an address is
4107        // not one of those.
4108        //
4109        // Whether any instruction reads an operand an instruction above it wrote is counted in the
4110        // same walk too. Such a template is one whose instructions have to be written in order with
4111        // each read taken from wherever the last write left the operand, which is what
4112        // [`Self::woven`] does, and so is one that writes an operand twice.
4113        let mut writes = vec![0usize; list.len()];
4114        let mut reads = vec![false; list.len()];
4115        let mut held = vec![false; list.len()];
4116        let mut after = false;
4117        for step in &steps {
4118            // A call out of the template writes every register the convention lets the callee
4119            // leave anything in, and an output pinned to one of those is written by it.
4120            if let x86_64::Step::Call { .. } = step {
4121                for index in self.lost(&list).into_iter().filter_map(|(_, _, index)| index) {
4122                    *writes.get_mut(index).ok_or_else(refused)? += 1;
4123                }
4124                continue;
4125            }
4126            let x86_64::Step::Line(line) = step else { continue };
4127            match line.at.and_then(|at| at.base) {
4128                Some(x86_64::Piece::Operand { index, .. }) => {
4129                    *held.get_mut(index).ok_or_else(refused)? = true;
4130                    after |= writes[index] > 0;
4131                }
4132                Some(x86_64::Piece::Reg { reg, .. }) => {
4133                    if let Some(index) = bound(&list, reg, Role::Use) {
4134                        *held.get_mut(index).ok_or_else(refused)? = true;
4135                        after |= writes[index] > 0;
4136                    }
4137                }
4138                _ => {}
4139            }
4140            let mut written = Vec::new();
4141            let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4142            // Which registers the instruction reaches, asked the same way it is asked again when
4143            // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
4144            // comes from the constraint letters rather than from the description.
4145            let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
4146            let (described, pieces) = match &lettered {
4147                Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
4148                None => (form.operands(), line.operands.as_slice()),
4149            };
4150            for (desc, piece) in described.iter().zip(pieces) {
4151                // An operand the instruction reaches without its text saying so is the statement's
4152                // only when a constraint letter put something there. One that is nobody's writes
4153                // nothing of the program's, so it is counted nowhere and is dealt with where it is
4154                // placed.
4155                let index = match *piece {
4156                    x86_64::Piece::Operand { index, .. } => index,
4157                    x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
4158                        Some(index) => index,
4159                        None => continue,
4160                    },
4161                    x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
4162                        Some(index) => index,
4163                        None => continue,
4164                    },
4165                };
4166                *held.get_mut(index).ok_or_else(refused)? = true;
4167                if matches!(desc.role, Role::Def | Role::EarlyDef) {
4168                    written.push(index);
4169                } else {
4170                    *reads.get_mut(index).ok_or_else(refused)? = true;
4171                    after |= writes[index] > 0;
4172                }
4173            }
4174            for index in written {
4175                *writes.get_mut(index).ok_or_else(refused)? += 1;
4176            }
4177        }
4178        let woven = after
4179            || writes.iter().any(|&count| count > 1)
4180            || steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_)));
4181
4182        // Where every operand is. Worked out in full before the first instruction is written, since
4183        // reading a value may be what puts it in a register in the first place, and that has to
4184        // happen in front of the assembly rather than in the middle of it.
4185        let mut places: Vec<Place> = vec![Place::default(); list.len()];
4186        for (index, operand) in list.iter().copied().enumerate() {
4187            let Some(result) = operand.result else {
4188                // An input, or an output the assembly was handed the address of, and both are a
4189                // value that arrives in a register and is read out of it, unless no instruction of
4190                // the template reads it out of one.
4191                let value = operand.value.ok_or_else(refused)?;
4192                if held[index] {
4193                    places[index].read = Some(self.reg_of(value)?);
4194                }
4195                continue;
4196            };
4197            let ty = self.source[result].ty;
4198            if on_x87(ty) {
4199                return Err(refused());
4200            }
4201            let tied = operands.tied_to(index);
4202            if let Some(from) = tied {
4203                if self.class_of(self.source[from].ty) != self.class_of(ty) {
4204                    return Err(refused());
4205                }
4206                places[index].read = Some(self.reg_of(from)?);
4207            }
4208            if writes[index] > 0 {
4209                places[index].write = Some(self.new_reg(result));
4210                continue;
4211            }
4212            match tied {
4213                // The place the input arrived in, which the assembly wrote nothing over. One
4214                // register, so this is a rename rather than a move.
4215                Some(_) => {
4216                    let reg = places[index].read.ok_or_else(refused)?;
4217                    self.regs[result.index()] = Some(reg);
4218                    places[index].write = Some(reg);
4219                }
4220                None => {
4221                    self.undefined(inst, result)?;
4222                    places[index].write = self.regs[result.index()];
4223                }
4224            }
4225        }
4226
4227        // An output an instruction of the template also reads, which the statement said nothing
4228        // about because an output is what a statement says the other thing about. What it holds
4229        // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
4230        // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
4231        // than for the number, so whatever the register held, the answer is the same. Undefined is
4232        // not the same as absent though, since the allocator is owed a definition in front of every
4233        // use, so it gets the zero an output nothing wrote gets and for the same reason.
4234        //
4235        // Unless an input could have been in the same register, in which case gcc's allocator puts
4236        // it there whenever it can and a program may have been written against that. tcc's test of
4237        // a call from a template reads its output `"=a" (s)` to pass `"r" (str)` to `getenv`, which
4238        // is only the string because gcc gave the two of them `rax`. So an output nothing has
4239        // written yet reads the one input that could share its place, when there is exactly one.
4240        // One written `&` is written before the inputs are read and shares nothing.
4241        for index in 0..list.len() {
4242            if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
4243                continue;
4244            }
4245            let reg = match self.shared(&list, index) {
4246                Some(value) => self.reg_of(value)?,
4247                None => self.seeded(inst, list[index])?,
4248            };
4249            places[index].read = Some(reg);
4250        }
4251
4252        // Worked out once for the whole template, since the list is one list and every instruction
4253        // of the template gets it. Not worked out at all for a template with no instructions, which
4254        // is where there is nothing for it to go on.
4255        let clobbers = self.names.resolve(info.clobbers).to_string();
4256        let clobbered =
4257            if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
4258
4259        // A template with a label in it is not one run of instructions, and what it is instead is
4260        // in [`Self::woven`], which is also where a template goes whose instructions read what the
4261        // ones above them wrote. Every other template is what it has always been, which is every
4262        // instruction of it written into the block the statement stands in.
4263        if woven {
4264            return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
4265        }
4266        for step in &steps {
4267            let x86_64::Step::Line(line) = step else { continue };
4268            self.instruction(inst, line, &places, &list, &clobbered)?;
4269        }
4270        Ok(())
4271    }
4272
4273    /// A template the reader could not take apart, kept as its text. See [`x86_64::Form::Template`].
4274    ///
4275    /// What the text names is spelled into it here, the way gcc prints it into its listing: a
4276    /// constant as `$5`, or as `5` under the `c` modifier, and the address of a name as the name.
4277    /// An object in memory is the one thing that cannot be spelled yet, since where it is depends on
4278    /// registers nothing has chosen, so it is left as a hole the writer fills and its address is the
4279    /// instruction's memory operand. One is all an instruction has room for, and every template this
4280    /// has met names one at most. A template that names an operand by name rather than by number is
4281    /// refused for now.
4282    ///
4283    /// # An operand in a register
4284    ///
4285    /// Which register is not known until the allocator has run, and the text is written down before
4286    /// then, so an operand in a register is a hole too. It names the instruction's own operand and
4287    /// the width the modifier asked for, or the width of the operand's type when there was none,
4288    /// and the writer spells whatever register the operand ended up in. What the text writes goes
4289    /// in first as definitions and what it reads goes in last as uses, with the registers below in
4290    /// between, so the allocator sees the statement as one instruction with every operand said. An
4291    /// output tied to an input, by `+` or by a number, reuses the input's register, and one written
4292    /// `&` is written early. Anything wider than a general purpose register is refused.
4293    ///
4294    /// A statement written with no colons is basic assembly, where `%` is a character like any
4295    /// other and a register is written `%eax`. The front end keeps no mark of which kind a statement
4296    /// was, so one with no operands and no clobbers is read as basic, which is what gcc would do for
4297    /// every such template but one written with empty colons around it.
4298    ///
4299    /// The registers a call may write are taken as written, see below for why.
4300    fn kept(
4301        &mut self,
4302        inst: Inst,
4303        template: &str,
4304        list: &[AsmOperand<'_>],
4305        widths: &[Option<x86_64::Width>],
4306        memory: &[bool],
4307    ) -> Result<(), Unsupported> {
4308        // Refused as the template it is, since keeping it is what was tried after reading it
4309        // failed, and what could not be kept is what it names rather than any one operand.
4310        let refused = || Unsupported::Assembly { inst, refused: Written::Template };
4311        let data = &self.source[inst];
4312        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4313        let clobbers = self.names.resolve(self.source[asm].clobbers).to_string();
4314        let basic = list.is_empty() && clobbers.trim().is_empty();
4315
4316        // Every register a call may leave anything in, as well as the ones the list names. The
4317        // text can write any register it likes without saying so, and tcc's tests do: gcc gets
4318        // away with that at `-O0` because nothing lives in a register between two statements
4319        // there, and taking these away from the allocator across the template is what gives the
4320        // same answer here. Nothing is written to them by this, so a register one template leaves
4321        // a value in is still holding it when the next template reads it.
4322        let a64 = self.on_aarch64();
4323        let mut clobbered: Vec<(PhysReg, RegClass)> =
4324            self.lost(list).into_iter().map(|(reg, class, _)| (reg, class)).collect();
4325        let named = if a64 {
4326            Self::clobbered_a64(inst, &clobbers)?
4327        } else {
4328            Self::clobbered_x86(inst, &clobbers, self.gpr, self.conv.sse_class)?
4329        };
4330        for &(reg, class) in &named {
4331            if !clobbered.iter().any(|&(had, of)| had == reg && of == class) {
4332                clobbered.push((reg, class));
4333            }
4334        }
4335
4336        // The file each operand is in. On AArch64 `w` is a floating point or vector register and an
4337        // input tied to an output is in that output's file. A value whose type puts it in the other
4338        // file would need a move into this one first, which gcc makes and this does not yet, so
4339        // that is refused below.
4340        let mut files = vec![self.gpr; list.len()];
4341        if a64 {
4342            let constraints = self.names.resolve(self.source[asm].constraints);
4343            for (file, entry) in files.iter_mut().zip(constraints.split(',')) {
4344                if vector_letter(entry) {
4345                    *file = self.conv.sse_class;
4346                }
4347            }
4348            for index in 0..list.len() {
4349                if let Some(&file) = list[index].tied.and_then(|output| files.get(output)) {
4350                    files[index] = file;
4351                }
4352            }
4353        }
4354        let pins: Vec<_> = list.iter().map(|operand| self.pinned_here(operand)).collect();
4355        let pin = |index: usize, file: RegClass| match pins[index] {
4356            Some((at, class)) if class == file => Ok(Some(Constraint::Fixed(at))),
4357            Some(_) => Err(refused()),
4358            None => Ok(None),
4359        };
4360
4361        // The operands in a register, as the instruction's own. An input the text is handed as a
4362        // constant or as the address of a name is spelled into the text instead, when its
4363        // constraint allows a constant at all and no output is tied to it. `"a" (0x1234)` is a
4364        // register holding the number, the way gcc loads it, since the text may ask for `%h0`.
4365        let mut defs: Vec<mir::Operand> = Vec::new();
4366        let mut uses: Vec<mir::Operand> = Vec::new();
4367        let mut def_of: Vec<Option<usize>> = vec![None; list.len()];
4368        let mut use_of: Vec<Option<usize>> = vec![None; list.len()];
4369        if !basic {
4370            for (index, operand) in list.iter().enumerate() {
4371                let Some(result) = operand.result else { continue };
4372                let (ty, file) = (self.source[result].ty, files[index]);
4373                if on_x87(ty) || self.class_of(ty) != file {
4374                    return Err(refused());
4375                }
4376                let reg = self.new_reg(result);
4377                let written = if operand.early {
4378                    mir::Operand::write_early(reg, file)
4379                } else {
4380                    mir::Operand::write(reg, file)
4381                };
4382                def_of[index] = Some(defs.len());
4383                defs.push(match pin(index, file)? {
4384                    Some(fixed) => written.with(fixed),
4385                    None => written,
4386                });
4387            }
4388            for (index, operand) in list.iter().enumerate() {
4389                let Some(value) = operand.value else { continue };
4390                let spelled = operand.result.is_none()
4391                    && operand.tied.is_none()
4392                    && operand.immediate
4393                    && (self.number(value).is_some() || self.named_address(value).is_some());
4394                // An operand in memory is spelled on AArch64 as the register its address is in,
4395                // which is `[x3]` and is an address every instruction that takes one reads.
4396                if (operand.memory && !a64) || spelled {
4397                    continue;
4398                }
4399                let (ty, file) = (self.source[value].ty, files[index]);
4400                if on_x87(ty) || self.class_of(ty) != file {
4401                    return Err(refused());
4402                }
4403                let read = mir::Operand::read(self.reg_of(value)?, file);
4404                use_of[index] = Some(uses.len());
4405                uses.push(match pin(index, file)? {
4406                    Some(fixed) => read.with(fixed),
4407                    None => read,
4408                });
4409            }
4410        }
4411        // Every register a call may write is more than a template can give up when it has more
4412        // operands in registers than the convention keeps across a call. `sodium_sub` in
4413        // libsodium's `utils.c` is one: eight outputs written early and two inputs pinned, against
4414        // the five registers SysV preserves, so an output has nowhere to go and nothing is left to
4415        // carry one to its slot either. gcc gives that template ten registers, and a program that
4416        // writes a register it did not name is only owed what gcc would have done, which here is
4417        // one of the ten. So the registers taken as written without being named are handed back,
4418        // from the end of the convention's order, until the operands fit in what is left. One the
4419        // list names or an operand is pinned to stays where it is. What is left does not count the
4420        // two scratch registers the allocator holds back, since no operand is ever given one of
4421        // those, and counting them left two outputs short above -O0 with nothing to carry them.
4422        let fixed_to: Vec<PhysReg> = defs
4423            .iter()
4424            .chain(&uses)
4425            .filter_map(|operand| match operand.constraint {
4426                Constraint::Fixed(at) => Some(at),
4427                _ => None,
4428            })
4429            .collect();
4430        let wanted = defs.iter().chain(&uses).count() - fixed_to.len();
4431        let int = self.conv.int_class;
4432        let held: &[PhysReg] =
4433            if a64 { &crate::pipeline::AARCH64_SCRATCH } else { &crate::pipeline::SCRATCH };
4434        let free = |clobbered: &[(PhysReg, RegClass)]| {
4435            self.conv
4436                .int_order
4437                .iter()
4438                .filter(|&&reg| {
4439                    !held.contains(&reg)
4440                        && !fixed_to.contains(&reg)
4441                        && !clobbered.contains(&(reg, int))
4442                })
4443                .count()
4444        };
4445        while free(&clobbered) < wanted {
4446            let Some(at) = clobbered.iter().rposition(|&(reg, class)| {
4447                class == int && !named.contains(&(reg, class)) && !fixed_to.contains(&reg)
4448            }) else {
4449                break;
4450            };
4451            clobbered.remove(at);
4452        }
4453
4454        // A register an output is pinned to is that output's definition and not a clobber as well.
4455        // One an input is pinned to is written as the instruction finishes, the way a call writes
4456        // the register its argument came in, and every other one is written early, since the text
4457        // may write it before it has read its inputs and an input must not be in it.
4458        let mut written: Vec<mir::Operand> = Vec::new();
4459        for (reg, class) in clobbered {
4460            let fixed = |operand: &mir::Operand| {
4461                operand.class == class && operand.constraint == Constraint::Fixed(reg)
4462            };
4463            if defs.iter().any(fixed) {
4464                continue;
4465            }
4466            let reg = mir::Reg::physical(reg);
4467            written.push(if uses.iter().any(fixed) {
4468                mir::Operand::write(reg, class)
4469            } else {
4470                mir::Operand::write_early(reg, class)
4471            });
4472        }
4473        // An output tied to an input is one register, which the definition says by reusing the
4474        // use, or by both being fixed to the same one when the output was pinned.
4475        //
4476        // A reused register is kept from every other input already, since the allocator counts the
4477        // output as taken from where the instruction reads. So `+&` asks for nothing more than `+`,
4478        // and saying it as an early write as well costs a register: the allocator only hands an
4479        // output the register of the input it reuses when the output starts at the instruction, and
4480        // an early one starts a point sooner, so it gets one of its own and a copy in front. Eleven
4481        // operands written that way in xz's range decoder need seventeen registers and run out. The
4482        // one case where `&` still means something is an input reading the same value as the one
4483        // tied, which would be in the same register and read after the output was written.
4484        let first_use = defs.len() + written.len();
4485        for (output, operand) in list.iter().enumerate() {
4486            let Some(def) = def_of[output] else { continue };
4487            let input = if operand.value.is_some() {
4488                Some(output)
4489            } else {
4490                list.iter().position(|entry| entry.tied == Some(output))
4491            };
4492            let Some(read) = input.and_then(|input| use_of[input]) else { continue };
4493            match defs[def].constraint {
4494                Constraint::Fixed(_) => uses[read].constraint = defs[def].constraint,
4495                _ => {
4496                    let at = u8::try_from(first_use + read).map_err(|_| refused())?;
4497                    defs[def].constraint = Constraint::Reuse(at);
4498                    let source = uses[read].reg;
4499                    let shared = uses
4500                        .iter()
4501                        .enumerate()
4502                        .any(|(other, operand)| other != read && operand.reg == source);
4503                    if defs[def].role == Role::EarlyDef && !shared {
4504                        defs[def].role = Role::Def;
4505                    }
4506                }
4507            }
4508        }
4509
4510        // A line naming an operand in a register, with an instruction on it the reader knows, is
4511        // one the reader refused for a reason of its own, and keeping it as text would hand the
4512        // assembler what the reader already said no to. `addq %1, %k0` is that: a quadword add
4513        // into half a register. What is kept is a line with an instruction nothing here knows.
4514        let registered = |index: usize| def_of[index].is_some() || use_of[index].is_some();
4515        if !a64 && (0..list.len()).any(registered) {
4516            for line in template.split(['\n', ';']) {
4517                if names_one(line, registered)
4518                    && x86_64::known(line, widths, memory)
4519                    && x86_64::read_in(line, widths, memory).is_none()
4520                {
4521                    return Err(refused());
4522                }
4523            }
4524        }
4525
4526        let mut text = String::with_capacity(template.len());
4527        let mut memory: Option<usize> = None;
4528        if basic {
4529            text.push_str(template);
4530        } else {
4531            let mut chars = template.chars().peekable();
4532            // Inside `{att|intel}`, and past the `|` in it, which is the half nobody reads. AArch64
4533            // has one dialect, and a brace there is a list of vector registers.
4534            let mut dialect = false;
4535            let mut skipped = false;
4536            while let Some(c) = chars.next() {
4537                match c {
4538                    '{' if !a64 => {
4539                        dialect = true;
4540                        continue;
4541                    }
4542                    '|' if dialect => {
4543                        skipped = true;
4544                        continue;
4545                    }
4546                    '}' if dialect => {
4547                        dialect = false;
4548                        skipped = false;
4549                        continue;
4550                    }
4551                    _ if skipped => continue,
4552                    '%' => {}
4553                    _ => {
4554                        text.push(c);
4555                        continue;
4556                    }
4557                }
4558                match chars.peek().copied() {
4559                    Some(c @ ('%' | '{' | '|' | '}')) => {
4560                        chars.next();
4561                        text.push(c);
4562                        continue;
4563                    }
4564                    Some('=') => {
4565                        chars.next();
4566                        text.push_str(&inst.index().to_string());
4567                        continue;
4568                    }
4569                    _ => {}
4570                }
4571                let modifier = match chars.peek().copied() {
4572                    Some(c) if c.is_ascii_alphabetic() => {
4573                        chars.next();
4574                        Some(c)
4575                    }
4576                    _ => None,
4577                };
4578                let mut digits = String::new();
4579                while let Some(c) = chars.peek().copied().filter(char::is_ascii_digit) {
4580                    digits.push(c);
4581                    chars.next();
4582                }
4583                let index: usize = digits.parse().map_err(|_| refused())?;
4584                let operand = list.get(index).ok_or_else(refused)?;
4585                if operand.memory && a64 {
4586                    let at = use_of[index].map(|at| first_use + at).ok_or_else(refused)?;
4587                    if modifier.is_some() {
4588                        return Err(refused());
4589                    }
4590                    text.push('[');
4591                    text.push_str(&template_reg(at, 'x'));
4592                    text.push(']');
4593                    continue;
4594                }
4595                if operand.memory {
4596                    if modifier.is_some() || memory.is_some_and(|had| had != index) {
4597                        return Err(refused());
4598                    }
4599                    memory = Some(index);
4600                    text.push_str(x86_64::TEMPLATE_MEM);
4601                    continue;
4602                }
4603                let placed = def_of[index].or(use_of[index].map(|at| first_use + at));
4604                if let Some(at) = placed {
4605                    let value = operand.result.or(operand.value).ok_or_else(refused)?;
4606                    let bits = held_bits(self.source[value].ty);
4607                    // `w` and `x` are the two names every general purpose register has, and one
4608                    // with no modifier is named at the width of its type, as gcc names it. A
4609                    // vector register with no modifier is `v`, which is what gcc writes for one
4610                    // whatever is in it, and the modifiers name the scalar views of it.
4611                    let width = if a64 && files[index] != self.gpr {
4612                        match modifier {
4613                            None => 'v',
4614                            Some(view @ ('b' | 'h' | 's' | 'd' | 'q')) => view,
4615                            Some(_) => return Err(refused()),
4616                        }
4617                    } else if a64 {
4618                        match (modifier, bits) {
4619                            (None, 8 | 16 | 32) | (Some('w'), _) => 'w',
4620                            (None, 64) | (Some('x'), _) => 'x',
4621                            _ => return Err(refused()),
4622                        }
4623                    } else {
4624                        match modifier {
4625                            None => match held_bits(self.source[value].ty) {
4626                                8 => 'b',
4627                                16 => 'w',
4628                                32 => 'k',
4629                                64 => 'q',
4630                                _ => return Err(refused()),
4631                            },
4632                            Some(width @ ('b' | 'w' | 'k' | 'q')) => width,
4633                            // The second byte is a name only four registers have, so it is taken for
4634                            // an operand pinned to one of them and for nothing the allocator chose.
4635                            Some('h') if pinned(operand).and_then(x86_64::gpr_high).is_some() => {
4636                                'h'
4637                            }
4638                            Some(_) => return Err(refused()),
4639                        }
4640                    };
4641                    text.push_str(&template_reg(at, width));
4642                    continue;
4643                }
4644                let value = operand.value.ok_or_else(refused)?;
4645                let bare = match modifier {
4646                    None => false,
4647                    Some('c' | 'P' | 'p') => true,
4648                    Some(_) => return Err(refused()),
4649                };
4650                // A constant is bare on AArch64 whatever the modifier, which is how gcc prints one
4651                // there and a form GNU as takes wherever `#` would go.
4652                if !bare && !a64 {
4653                    text.push('$');
4654                }
4655                if let Some(number) = self.number(value) {
4656                    text.push_str(&number.to_string());
4657                } else if let Some(symbol) = self.named_address(value) {
4658                    text.push_str(&template_name(self.names.resolve(symbol)));
4659                } else {
4660                    return Err(refused());
4661                }
4662            }
4663        }
4664
4665        // An object in this function's frame is named by where it is in the frame, the way gcc
4666        // names it, rather than by a register its address was put in first. The text may write
4667        // registers it does not declare, and tcc's tests do: one that writes `%ecx` behind the
4668        // compiler's back would otherwise take the address with it.
4669        let mut local = None;
4670        let at = match memory.filter(|_| !a64) {
4671            Some(index) => {
4672                let value = list[index].value.ok_or_else(refused)?;
4673                local = self.local_of(value);
4674                let base = match local {
4675                    Some(_) => mir::Reg::physical(self.conv.stack_pointer),
4676                    None => self.reg_of(value)?,
4677                };
4678                Some(mir::Mem::at(mir::Operand::read(base, self.gpr)))
4679            }
4680            None => None,
4681        };
4682        let symbol = self.names.intern(&text);
4683        let opcode = self.named(if a64 { aarch64::TEMPLATE } else { x86_64::TEMPLATE });
4684        let block = self.at.expect("a block is being filled");
4685        let span = self.source.span(inst);
4686        let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4687        for operand in defs.into_iter().chain(written).chain(uses) {
4688            build = build.operand(operand);
4689        }
4690        if let Some(mem) = at {
4691            build = build.mem(mem);
4692        }
4693        let made = build.finish();
4694        if let Some(local) = local {
4695            self.stack.addresses.push((made, local));
4696        }
4697        Ok(())
4698    }
4699
4700    /// The object in this function's frame a value is the address of, for one an `alloca` of a
4701    /// size known here made. See [`Self::reserve`], which is where the `lea` it is found by came
4702    /// from.
4703    fn local_of(&self, value: Value) -> Option<usize> {
4704        let Def::Result { inst, .. } = self.source[value].def else { return None };
4705        if self.source[inst].opcode != Opcode::Alloca
4706            || !self.source[self.source[inst].args].is_empty()
4707        {
4708            return None;
4709        }
4710        let reg = self.regs[value.index()]?;
4711        self.stack.addresses.iter().find_map(|&(made, local)| {
4712            let data = &self.out[made];
4713            let defined = self.out[data.operands].first()?;
4714            (defined.reg == reg).then_some(local)
4715        })
4716    }
4717
4718    /// The name a value is the address of, for one a `global_addr` defined.
4719    fn named_address(&self, value: Value) -> Option<Symbol> {
4720        let Def::Result { inst, .. } = self.source[value].def else { return None };
4721        if self.source[inst].opcode != Opcode::GlobalAddr {
4722            return None;
4723        }
4724        let Extra::Symbol(symbol) = self.source[inst].extra else { return None };
4725        Some(symbol)
4726    }
4727
4728    /// A register holding a zero, for an operand of a template that is read before anything filled
4729    /// it.
4730    ///
4731    /// Two things ask for this and they are the same thing twice. An output the template reads has
4732    /// nothing to be read out of until the instruction that writes it has run, and a loop carries
4733    /// an operand into a block before the instruction that fills it, so both are a use in front of
4734    /// every definition. What the program is owed there is nothing, since the value is undefined
4735    /// either way, and what the allocator is owed is a register something wrote.
4736    fn seeded(&mut self, inst: Inst, operand: AsmOperand<'_>) -> Result<mir::Reg, Unsupported> {
4737        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4738        let value = operand.result.or(operand.value).ok_or_else(refused)?;
4739        let class = self.class_of(self.source[value].ty);
4740        if class != self.gpr {
4741            return Err(refused());
4742        }
4743        let block = self.at.expect("a block is being filled");
4744        let reg = self.out.new_vreg(class);
4745        let put = self.named("mov_ri_64");
4746        self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
4747        Ok(reg)
4748    }
4749
4750    /// A template with labels in it, as the blocks its jumps leave and arrive at.
4751    ///
4752    /// A statement is an instruction of the IR and stands inside one block, so a template that
4753    /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
4754    /// stands in and gives it two arms, and whatever follows the statement goes into whichever
4755    /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
4756    /// what [`Self::saves_place`] already does for the same reason.
4757    ///
4758    /// # What is carried between them
4759    ///
4760    /// The machine IR here is in the form where a register is written once, so an operand written
4761    /// inside a loop and read again at the top of it cannot be one register. What arrives at the
4762    /// top is a parameter of that block, and every jump to it carries whichever register held the
4763    /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
4764    /// made takes one parameter for each operand that is in a register at all, in one order, so an
4765    /// arm's arguments and a block's parameters are the same list read twice.
4766    ///
4767    /// Which register an operand is in at each point is kept in the read half of its place, since
4768    /// that is what the instructions below read it out of. An instruction that writes an operand
4769    /// leaves it in the register it wrote, and a jump below carries that one. The block an
4770    /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
4771    /// about where the operands are changes there.
4772    ///
4773    /// An operand written by the template and filled by nothing is written as a zero first, for
4774    /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
4775    /// instruction that fills it has run, and an argument has to be a register something wrote.
4776    ///
4777    /// # The condition state
4778    ///
4779    /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
4780    /// it are both written here, next to each other in one block, and what the allocator may put
4781    /// between them is a move, which on this machine leaves the condition state alone. The edge
4782    /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
4783    /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
4784    fn woven(
4785        &mut self,
4786        inst: Inst,
4787        steps: &[x86_64::Step],
4788        places: &mut [Place],
4789        list: &[AsmOperand<'_>],
4790        clobbered: &[PhysReg],
4791        writes: &[usize],
4792    ) -> Result<(), Unsupported> {
4793        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4794        let span = self.source.span(inst);
4795
4796        // Which operands are carried, which is every one that is in a register at all. An operand
4797        // the template never puts in one, such as a constant it names only as the distance into an
4798        // address, is in the instruction and has nowhere to be carried from.
4799        let mut carried: Vec<(usize, RegClass)> = Vec::new();
4800        for (index, operand) in list.iter().enumerate() {
4801            if places[index].read.is_none() && places[index].write.is_none() {
4802                continue;
4803            }
4804            let value = operand.result.or(operand.value).ok_or_else(refused)?;
4805            let ty = self.source[value].ty;
4806            if on_x87(ty) {
4807                return Err(refused());
4808            }
4809            carried.push((index, self.class_of(ty)));
4810        }
4811
4812        // What each of them holds where the template starts.
4813        for &(index, _) in &carried {
4814            if places[index].read.is_some() {
4815                continue;
4816            }
4817            if writes[index] == 0 {
4818                places[index].read = places[index].write;
4819                continue;
4820            }
4821            places[index].read = Some(self.seeded(inst, list[index])?);
4822        }
4823
4824        // The blocks, made before the walk because a jump forwards names a label the walk has not
4825        // reached yet.
4826        let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
4827        for step in steps {
4828            let x86_64::Step::Label(name) = step else { continue };
4829            let block = self.out.create_block();
4830            let mut params = Vec::with_capacity(carried.len());
4831            for &(_, class) in &carried {
4832                params.push(self.out.append_param(block, class));
4833            }
4834            labels.push((name.as_str(), block, params));
4835        }
4836
4837        let mut wrote: Vec<usize> = Vec::new();
4838        for step in steps {
4839            match step {
4840                x86_64::Step::Label(name) => {
4841                    let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
4842                    let from = self.at.expect("a block is being filled");
4843                    let args = Self::held(places, &carried).ok_or_else(refused)?;
4844                    *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
4845                    self.at = Some(block);
4846                    for (at, &(index, _)) in carried.iter().enumerate() {
4847                        places[index].read = params.get(at).copied();
4848                    }
4849                }
4850                x86_64::Step::Jump { opcode, to } => {
4851                    let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
4852                    let from = self.at.expect("a block is being filled");
4853                    let args = Self::held(places, &carried).ok_or_else(refused)?;
4854                    let opcode = self.named(opcode);
4855                    self.out.build(from, opcode).at(span).finish();
4856                    let next = self.out.create_block();
4857                    *self.out.succs_mut(from) =
4858                        vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
4859                    self.at = Some(next);
4860                }
4861                x86_64::Step::Away { symbol } => {
4862                    // Only in a function that is written without a prologue, which is the one
4863                    // place the jump means what it says. Anywhere else there is an epilogue behind
4864                    // the statement that puts the registers back and gives the frame up, and a
4865                    // jump over it goes to the next function with this function's frame still
4866                    // taken. The reader already made sure it is the last step of the template, so
4867                    // what is left to ask is about the function around it.
4868                    if !self.source.attrs.set.contains(AttrSet::NAKED) {
4869                        return Err(Unsupported::Assembly { inst, refused: Written::Away });
4870                    }
4871                    let from = self.at.expect("a block is being filled");
4872                    let opcode = self.named(AWAY);
4873                    let symbol = self.names.intern(symbol);
4874                    self.out.build(from, opcode).at(span).symbol(symbol).finish();
4875                    // Nowhere, which is what a jump out of the function leaves behind it and is
4876                    // the same list a `ret` leaves. The block after it is made for the walk above
4877                    // rather than for the program: the statement may be in the middle of a body
4878                    // that goes on being lowered, and what that lowering writes is reached by
4879                    // nothing and thrown away with the block.
4880                    *self.out.succs_mut(from) = Vec::new();
4881                    self.at = Some(self.out.create_block());
4882                }
4883                x86_64::Step::Call { symbol } => {
4884                    self.call_out(inst, symbol, places, list, clobbered, &carried, &mut wrote)?;
4885                }
4886                x86_64::Step::Line(line) => {
4887                    let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4888                    let mut written = Vec::new();
4889                    for (desc, piece) in form.operands().iter().zip(&line.operands) {
4890                        if !desc.role.is_def() {
4891                            continue;
4892                        }
4893                        let index = match *piece {
4894                            x86_64::Piece::Operand { index, .. } => index,
4895                            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
4896                                Some(index) => index,
4897                                None => continue,
4898                            },
4899                            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
4900                                Some(index) => index,
4901                                None => continue,
4902                            },
4903                        };
4904                        written.push(index);
4905                    }
4906                    // A register is written once in this form of the machine IR, so an operand
4907                    // an instruction above already wrote is written into a new one here, and what
4908                    // reads it below reads that one.
4909                    for &index in &written {
4910                        if !wrote.contains(&index) {
4911                            wrote.push(index);
4912                            continue;
4913                        }
4914                        let &(_, class) =
4915                            carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4916                        let place = places.get_mut(index).ok_or_else(refused)?;
4917                        place.write = Some(self.out.new_vreg(class));
4918                    }
4919                    self.instruction(inst, line, places, list, clobbered)?;
4920                    for index in written {
4921                        let place = places.get_mut(index).ok_or_else(refused)?;
4922                        if place.write.is_some() {
4923                            place.read = place.write;
4924                        }
4925                    }
4926                }
4927            }
4928        }
4929
4930        // Where the walk left each output, which is the parameter of the block a label made when
4931        // the template ends in one and the register an instruction wrote when it does not.
4932        for (index, operand) in list.iter().enumerate() {
4933            let Some(result) = operand.result else { continue };
4934            if let Some(reg) = places[index].read {
4935                self.regs[result.index()] = Some(reg);
4936            }
4937        }
4938        Ok(())
4939    }
4940
4941    /// A template's call to a function somewhere else, as the call the convention makes.
4942    ///
4943    /// The opcode is the one a call written in C becomes, so everything that asks whether a
4944    /// function calls anything gets the answer it would for one: the stack pointer is left aligned
4945    /// at the statement and nothing is kept in the red zone. What is not the same is the operands.
4946    /// Nothing is passed by the convention, since the template put the arguments where it wanted
4947    /// them, and what comes back is whatever an output is pinned to, since that is the only thing
4948    /// the template says about it. Every other register the callee may leave anything in is
4949    /// written here, which is what a program that calls from a template never says and always
4950    /// means.
4951    #[allow(clippy::too_many_arguments)]
4952    fn call_out(
4953        &mut self,
4954        inst: Inst,
4955        symbol: &str,
4956        places: &mut [Place],
4957        list: &[AsmOperand<'_>],
4958        clobbered: &[PhysReg],
4959        carried: &[(usize, RegClass)],
4960        wrote: &mut Vec<usize>,
4961    ) -> Result<(), Unsupported> {
4962        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4963        let mut operands = Vec::new();
4964        let mut written = Vec::new();
4965        let lost = self.lost(list);
4966        for &(reg, class, index) in &lost {
4967            let Some(index) = index else {
4968                operands.push(mir::Operand::write(mir::Reg::physical(reg), class));
4969                continue;
4970            };
4971            // Written once in this form of the machine IR, so a second write is a new register,
4972            // the same as for an instruction in [`Self::woven`].
4973            if wrote.contains(&index) {
4974                let &(_, class) =
4975                    carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4976                places.get_mut(index).ok_or_else(refused)?.write = Some(self.out.new_vreg(class));
4977            } else {
4978                wrote.push(index);
4979            }
4980            let place = places.get(index).ok_or_else(refused)?.write.ok_or_else(refused)?;
4981            operands.push(mir::Operand::write(place, class).with(Constraint::Fixed(reg)));
4982            written.push(index);
4983        }
4984        for &reg in clobbered {
4985            if lost.iter().all(|&(gone, class, _)| gone != reg || class != self.gpr) {
4986                operands.push(mir::Operand::write(mir::Reg::physical(reg), self.gpr));
4987            }
4988        }
4989        let block = self.at.expect("a block is being filled");
4990        let span = self.source.span(inst);
4991        let opcode = mir::Opcode::new(self.names.intern(abi::CALL));
4992        let symbol = self.names.intern(symbol);
4993        let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4994        for operand in operands {
4995            build = build.operand(operand);
4996        }
4997        build.finish();
4998        let calls = &mut self.stack.calls;
4999        *calls = Some(calls.unwrap_or(0));
5000        for index in written {
5001            let place = places.get_mut(index).ok_or_else(refused)?;
5002            place.read = place.write;
5003        }
5004        Ok(())
5005    }
5006
5007    /// Every register a call may leave anything in, with its file and the output pinned to it if
5008    /// one is.
5009    ///
5010    /// A register is asked about with its file, since the two files are numbered from nought alike
5011    /// and a question about `v8` alone would find an output pinned to `x8`.
5012    ///
5013    /// The platform's own convention, whatever this function was written in, since what an `asm`
5014    /// statement calls is an ordinary function of the platform.
5015    fn lost(&self, list: &[AsmOperand<'_>]) -> Vec<(PhysReg, RegClass, Option<usize>)> {
5016        let conv = self.conv.under(Convention::Target).unwrap_or(self.conv);
5017        let ints = conv.int_order.iter().filter(|&&reg| !conv.preserves_int(reg));
5018        let sses = conv.sse_order.iter().filter(|&&reg| !conv.preserves_sse(reg));
5019        let written = |reg, class| {
5020            list.iter().position(|operand| {
5021                operand.result.is_some() && self.pinned_here(operand) == Some((reg, class))
5022            })
5023        };
5024        ints.map(|&reg| (reg, conv.int_class, written(reg, conv.int_class)))
5025            .chain(sses.map(|&reg| (reg, conv.sse_class, written(reg, conv.sse_class))))
5026            .collect()
5027    }
5028
5029    /// The input an output read before anything wrote it shares its register with, which is the
5030    /// one input that could be in that register, or nothing when there is none or more than one.
5031    ///
5032    /// Could be means nothing ties it elsewhere: it is in a register rather than in memory, no
5033    /// constraint pins it anywhere the output is not, and it is not tied to another output. An
5034    /// output written `&` shares nothing, since the assembly writes it before it reads the inputs.
5035    fn shared(&self, list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
5036        let output = list.get(index)?;
5037        if output.early || output.tied.is_some() {
5038            return None;
5039        }
5040        let class = self.class_of(self.source[output.result?].ty);
5041        let mut fits = list.iter().filter(|operand| {
5042            operand.result.is_none()
5043                && !operand.memory
5044                && operand.tied.is_none()
5045                && operand.value.is_some_and(|value| self.class_of(self.source[value].ty) == class)
5046                && pinned(operand).is_none_or(|reg| pinned(output) == Some(reg))
5047        });
5048        let value = fits.next()?.value;
5049        if fits.next().is_some() {
5050            return None;
5051        }
5052        value
5053    }
5054
5055    /// The block one of the template's labels made, and the parameters it takes.
5056    fn went<'b>(
5057        labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
5058        name: &str,
5059    ) -> Option<(mir::Block, &'b [mir::Reg])> {
5060        labels
5061            .iter()
5062            .find(|(had, ..)| *had == name)
5063            .map(|(_, block, params)| (*block, params.as_slice()))
5064    }
5065
5066    /// The register each carried operand is in, which is what an arm to a label carries.
5067    fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
5068        carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
5069    }
5070
5071    /// The registers a clobber list names, in the order it named them.
5072    ///
5073    /// Nothing is dropped. A name this has no register for is refused, because the list is the
5074    /// program telling the compiler which registers it may not leave anything in, and an entry
5075    /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
5076    /// two entries that are not registers and for why they are skipped rather than refused.
5077    fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
5078        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
5079        let mut named = Vec::new();
5080        for entry in clobbers.split(',') {
5081            let entry = entry.trim().trim_matches('"');
5082            // The sigil is optional in a clobber list and means nothing when it is there, unlike
5083            // in a template, where it is what tells a register from an operand.
5084            let entry = entry.strip_prefix('%').unwrap_or(entry);
5085            if entry.is_empty() || matches!(entry, "memory" | "cc" | "flags") {
5086                continue;
5087            }
5088            let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
5089            if !named.contains(&reg) {
5090                named.push(reg);
5091            }
5092        }
5093        Ok(named)
5094    }
5095
5096    /// [`Self::clobbered`] for a template kept as text, where a clobber may also name a vector
5097    /// register, `xmm0` or its wider spelling `ymm0`, which busybox's `xorbuf16_aligned_long` does.
5098    /// Each comes back with the file it is in, since `xmm0` and `rax` are both register nought.
5099    fn clobbered_x86(
5100        inst: Inst,
5101        clobbers: &str,
5102        gpr: RegClass,
5103        sse: RegClass,
5104    ) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
5105        let mut named = Vec::new();
5106        let mut general = Vec::new();
5107        for entry in clobbers.split(',') {
5108            match vector_named(entry) {
5109                Some(reg) => {
5110                    if !named.contains(&(reg, sse)) {
5111                        named.push((reg, sse));
5112                    }
5113                }
5114                None => general.push(entry),
5115            }
5116        }
5117        for reg in Self::clobbered(inst, &general.join(","))? {
5118            named.push((reg, gpr));
5119        }
5120        Ok(named)
5121    }
5122
5123    /// [`Self::clobbered`] on AArch64, where a clobber may name a vector register as well as a
5124    /// general purpose one, so each comes back with the file it is in. See [`aarch64::named`].
5125    fn clobbered_a64(inst: Inst, clobbers: &str) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
5126        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
5127        let mut named = Vec::new();
5128        for entry in clobbers.split(',') {
5129            let entry = entry.trim().trim_matches('"');
5130            if entry.is_empty() || matches!(entry, "memory" | "cc") {
5131                continue;
5132            }
5133            let reg = aarch64::named(entry).ok_or_else(refused)?;
5134            if !named.contains(&reg) {
5135                named.push(reg);
5136            }
5137        }
5138        Ok(named)
5139    }
5140
5141    /// Whether the machine being lowered for is AArch64.
5142    fn on_aarch64(&self) -> bool {
5143        std::ptr::eq(self.selector.shapes, &aarch64::MACHINE)
5144    }
5145
5146    /// The register an operand is pinned to on the machine being lowered for.
5147    ///
5148    /// [`pinned`] on x86, where it is always a general purpose register. AArch64 has no constraint
5149    /// letter for one register, so there only a local register variable pins anything, and its name
5150    /// is read against [`aarch64::named`], which may put it in either file. The file comes back with
5151    /// the register because the two are numbered from nought alike, and `x8` is not `v8`.
5152    fn pinned_here(&self, operand: &AsmOperand<'_>) -> Option<(PhysReg, RegClass)> {
5153        if !self.on_aarch64() {
5154            return pinned(operand).map(|reg| (reg, self.gpr));
5155        }
5156        let name = operand.named?;
5157        aarch64::named(name.strip_prefix('%').unwrap_or(name))
5158    }
5159
5160    /// An `asm` statement whose operands are `long double` values on the x87 stack.
5161    ///
5162    /// `t` is the top of the stack and `u` is the register under it, and those two letters, or a
5163    /// number tying an input to an output in one of them, are the only places taken here. That is
5164    /// what glibc's old `<bits/mathinline.h>` writes, `fpatan` with `=t`, `0` and `u` and `st(1)`
5165    /// in the clobber list, and it is gcc-torture `execute/990413-2.c`.
5166    ///
5167    /// The group is the shape every other one in [`Self::x87`] has. The inputs are pushed from the
5168    /// deepest up, so the `t` one is pushed last and ends up on top, then the template runs, then
5169    /// the outputs are popped into their slots from the top down. That leaves the stack as empty
5170    /// as it was found only when the template popped every input it was handed and pushed every
5171    /// output it says it leaves, and gcc's rule for these statements says when that is: an input
5172    /// tied to an output or named in the clobber list is one the template pops. So a statement
5173    /// with an input it leaves behind is refused, as is one with an operand anywhere other than
5174    /// `st(0)` and `st(1)`, since nothing here would know what to do with the stack after it.
5175    fn x87_assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
5176        let data = &self.source[inst];
5177        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
5178        let info = self.source[asm];
5179        if !self.source[info.targets].is_empty() {
5180            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
5181        }
5182        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5183        let constraints = self.names.resolve(info.constraints).to_string();
5184        let results: Vec<Value> = data.results().collect();
5185        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
5186            .ok_or_else(refused)?;
5187        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
5188
5189        // Where on the stack each operand is, as a depth from the top.
5190        let letters: Vec<&str> = constraints.split(',').collect();
5191        let mut depths = Vec::with_capacity(list.len());
5192        for (operand, letter) in list.iter().zip(&letters) {
5193            let value = operand.result.or(operand.value).ok_or_else(refused)?;
5194            if operand.memory || !on_x87(self.source[value].ty) {
5195                return Err(refused());
5196            }
5197            let depth = match operand.tied {
5198                Some(output) => *depths.get(output).ok_or_else(refused)?,
5199                None => match letter.trim_start_matches(['=', '+', '&']) {
5200                    "t" => 0,
5201                    "u" => 1,
5202                    _ => return Err(refused()),
5203                },
5204            };
5205            depths.push(depth);
5206        }
5207
5208        // Which depths the clobber list says the template pops.
5209        let clobbers = self.names.resolve(info.clobbers).to_string();
5210        let mut popped = [false; 2];
5211        for entry in clobbers.split(',') {
5212            let entry = entry.trim().trim_matches('"');
5213            let entry = entry.strip_prefix('%').unwrap_or(entry);
5214            match entry {
5215                "" | "memory" | "cc" | "flags" => {}
5216                "st" | "st(0)" => popped[0] = true,
5217                "st(1)" => popped[1] = true,
5218                _ => return Err(Unsupported::Assembly { inst, refused: Written::Clobber }),
5219            }
5220        }
5221
5222        // The inputs, one per depth and from the top down with no gap, and each one popped.
5223        let mut inputs: Vec<Option<Value>> = vec![None; 2];
5224        let mut outputs: Vec<Option<Value>> = vec![None; 2];
5225        for (index, operand) in list.iter().enumerate() {
5226            let depth = depths[index];
5227            if let Some(result) = operand.result {
5228                if outputs[depth].replace(result).is_some() {
5229                    return Err(refused());
5230                }
5231            }
5232            let Some(value) = operand.value else { continue };
5233            // An output written `+` is an input tied to itself.
5234            let consumed = operand.result.is_some() || operand.tied.is_some() || popped[depth];
5235            if !consumed {
5236                return Err(refused());
5237            }
5238            if inputs[depth].replace(value).is_some() {
5239                return Err(refused());
5240            }
5241        }
5242        let gapless =
5243            |held: &[Option<Value>]| held.iter().skip_while(|it| it.is_some()).all(Option::is_none);
5244        if !gapless(&inputs) || !gapless(&outputs) {
5245            return Err(refused());
5246        }
5247
5248        // The text, with an operand spelled as the register it is in.
5249        let template = self.names.resolve(info.template).to_string();
5250        let mut text = String::with_capacity(template.len());
5251        let mut chars = template.chars().peekable();
5252        while let Some(c) = chars.next() {
5253            if c != '%' {
5254                text.push(c);
5255                continue;
5256            }
5257            match chars.peek().copied() {
5258                Some('%') => {
5259                    chars.next();
5260                    text.push('%');
5261                }
5262                Some('=') => {
5263                    chars.next();
5264                    text.push_str(&inst.index().to_string());
5265                }
5266                Some(digit) if digit.is_ascii_digit() => {
5267                    chars.next();
5268                    if chars.peek().is_some_and(char::is_ascii_digit) {
5269                        return Err(refused());
5270                    }
5271                    let index = digit.to_digit(10).map_or(usize::MAX, |it| it as usize);
5272                    match depths.get(index).ok_or_else(refused)? {
5273                        0 => text.push_str("%st"),
5274                        depth => text.push_str(&format!("%st({depth})")),
5275                    }
5276                }
5277                _ => return Err(refused()),
5278            }
5279        }
5280
5281        let span = self.source.span(inst);
5282        for value in inputs.iter().rev().flatten() {
5283            let from = self.x87_slot(*value);
5284            let from = self.through(from);
5285            self.x87_at("fld_t", span, from);
5286        }
5287        let symbol = self.names.intern(&text);
5288        let opcode = self.named(x86_64::TEMPLATE);
5289        let block = self.at.expect("a block is being filled");
5290        self.out.build(block, opcode).at(span).symbol(symbol).finish();
5291        for value in outputs.iter().flatten() {
5292            let into = self.x87_slot(*value);
5293            let into = self.through(into);
5294            self.x87_at("fstp_t", span, into);
5295        }
5296        Ok(())
5297    }
5298
5299    /// An `asm` statement on AArch64, which is kept as text whatever is in it.
5300    ///
5301    /// Nothing reads AArch64 assembly back into instructions yet, so every template goes the way
5302    /// one the x86 reader could not take apart goes, which is [`Self::kept`]: the text is carried
5303    /// to the listing with a hole for each operand, and the operands are the instruction's own. A
5304    /// constraint with a letter whose meaning differs between the two machines is refused first.
5305    /// See [`shared_letters`].
5306    fn spelled(&mut self, inst: Inst) -> Result<(), Unsupported> {
5307        let data = &self.source[inst];
5308        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
5309        let info = self.source[asm];
5310        if self.jumps_from_text(inst) {
5311            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
5312        }
5313        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5314        let constraints = self.names.resolve(info.constraints).to_string();
5315        if !constraints.split(',').all(shared_letters) {
5316            return Err(refused());
5317        }
5318        // `Q` is memory addressed by one register and nothing else, which is how every operand in
5319        // memory is spelled here already, so it is read as `m`. See [`shared_letters`].
5320        let constraints = letters_outside(&constraints, |c| if c == 'Q' { 'm' } else { c });
5321        let results: Vec<Value> = data.results().collect();
5322        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
5323            .ok_or_else(refused)?;
5324        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
5325        let widths = vec![None; list.len()];
5326        let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
5327        let template = self.names.resolve(info.template).to_string();
5328        self.kept(inst, &template, &list, &widths, &memory)
5329    }
5330
5331    /// One instruction of a template, as the machine instruction it was read back into.
5332    fn instruction(
5333        &mut self,
5334        inst: Inst,
5335        line: &x86_64::Line,
5336        places: &[Place],
5337        list: &[AsmOperand<'_>],
5338        clobbered: &[PhysReg],
5339    ) -> Result<(), Unsupported> {
5340        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5341        let form = x86_64::form(line.opcode).ok_or_else(refused)?;
5342        // What the instruction reaches and what is in each of them. The description answers the
5343        // first for every opcode but one, and the pieces the template was read into answer the
5344        // second. Bytes a program wrote out itself are the one, since nothing in a number is a
5345        // register anybody could read, so the constraint letters answer both. See
5346        // [`Self::lettered`].
5347        let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
5348        let (described, pieces) = match &lettered {
5349            Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
5350            None => (form.operands(), line.operands.as_slice()),
5351        };
5352        let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
5353        for (desc, piece) in described.iter().zip(pieces) {
5354            built.push(self.placed(inst, *desc, *piece, places, list)?);
5355        }
5356        // The clobbers go in among the definitions rather than behind the reads, because an operand
5357        // vector in the machine IR is every definition and then every use and what counts them
5358        // reads that order rather than each operand's role.
5359        let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
5360        let mut added = 0usize;
5361        for &reg in clobbered {
5362            if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
5363                continue;
5364            }
5365            built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
5366            added += 1;
5367        }
5368        // A constraint tying one operand to another names it by its place in this vector, and the
5369        // clobbers were put in the middle of the vector, so everything behind them moved. The
5370        // description is written against an instruction with no clobbers in it and cannot know
5371        // that, which makes this the one place the two numberings have to be reconciled.
5372        for operand in &mut built {
5373            if let Constraint::Reuse(at) = operand.constraint {
5374                if usize::from(at) >= defs {
5375                    let moved = usize::from(at) + added;
5376                    operand.constraint =
5377                        Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
5378                }
5379            }
5380        }
5381        let at = match line.at {
5382            Some(at) => Some(self.addressed(inst, at, places, list)?),
5383            None => None,
5384        };
5385
5386        let block = self.at.expect("a block is being filled");
5387        let span = self.source.span(inst);
5388        let opcode = self.named(line.opcode);
5389        let mut build = self.out.build(block, opcode).at(span);
5390        for operand in built {
5391            build = build.operand(operand);
5392        }
5393        if let Some(value) = line.imm {
5394            build = build.imm(value);
5395        }
5396        if let Some(mem) = at {
5397            build = build.mem(mem);
5398        }
5399        build.finish();
5400        Ok(())
5401    }
5402
5403    /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
5404    /// description of an opcode.
5405    ///
5406    /// Every other instruction of a template has a description saying which registers it reaches
5407    /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
5408    /// wrote out itself have no such description and could not have one: what the instruction is, is
5409    /// a number, and nothing in a number is a register anything could read. So the letters are the
5410    /// whole of what is known, and they are enough, because a program writing an instruction this
5411    /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
5412    ///
5413    /// Each register named by a letter gets one entry for the write and one for the read, the same
5414    /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
5415    /// written here and one no input names is not read. The writes come first because that is the
5416    /// order an operand vector in the machine IR is counted in. A register named by nothing is left
5417    /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
5418    /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
5419    /// touch is known only from what the program said.
5420    fn lettered(&self, list: &[AsmOperand<'_>]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
5421        let mut named: Vec<PhysReg> = Vec::new();
5422        for operand in list {
5423            if let Some(reg) = pinned(operand) {
5424                if !named.contains(&reg) {
5425                    named.push(reg);
5426                }
5427            }
5428        }
5429        let mut described = Vec::with_capacity(named.len() * 2);
5430        let mut pieces = Vec::with_capacity(named.len() * 2);
5431        for role in [Role::Def, Role::Use] {
5432            for &reg in &named {
5433                if bound(list, reg, role).is_none() {
5434                    continue;
5435                }
5436                let desc = if role.is_def() {
5437                    OperandDesc::write(self.gpr)
5438                } else {
5439                    OperandDesc::read(self.gpr)
5440                };
5441                described.push(desc.with(Constraint::Fixed(reg)));
5442                pieces.push(x86_64::Piece::Implicit { reg });
5443            }
5444        }
5445        (described, pieces)
5446    }
5447
5448    /// One operand of one instruction of a template, in the register the statement put it in.
5449    fn placed(
5450        &mut self,
5451        inst: Inst,
5452        desc: OperandDesc,
5453        piece: x86_64::Piece,
5454        places: &[Place],
5455        list: &[AsmOperand<'_>],
5456    ) -> Result<mir::Operand, Unsupported> {
5457        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5458        // A register the instruction reaches without its text naming it belongs to whichever of the
5459        // statement's operands a constraint letter put there, and to nobody when no letter did.
5460        // There is no width to check in that case: the operand is the register the letter named and
5461        // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
5462        let (index, spelled) = match piece {
5463            x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
5464            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
5465                Some(index) => (index, None),
5466                None => return self.spare(inst, desc),
5467            },
5468            // A register the template named, which belongs to one of the statement's operands when
5469            // a constraint letter put that operand there and to nobody otherwise. Asked in that
5470            // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
5471            // the program saying one thing twice, and answering it twice would hand the allocator
5472            // one register holding two values.
5473            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
5474                Some(index) => (index, None),
5475                None => return self.itself(inst, desc, reg),
5476            },
5477        };
5478        let operand = list.get(index).copied().ok_or_else(refused)?;
5479        // The two halves of an operand written `+`, which arrives in one register and leaves in
5480        // another with the allocator told to make them the same one. Everything else has one of
5481        // the two and asking for the other is the refusal below.
5482        let place = places.get(index).copied().ok_or_else(refused)?;
5483        let reg = match desc.role {
5484            Role::Use => place.read,
5485            Role::Def | Role::EarlyDef => place.write,
5486        }
5487        .ok_or_else(refused)?;
5488
5489        // Read where the opcode reads and written where it writes, which is what the first half of
5490        // this asks. An output has a result and an input has a value, an output written `+` has
5491        // both because it is read before it is written, and an output a matching constraint names
5492        // is read as the input that named it. See [`read_as`].
5493        // An output with neither is read as well, and what it holds there is undefined, which
5494        // [`Self::assembly`] says why and puts a zero in a register for.
5495        let placeable = match desc.role {
5496            Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
5497            Role::Def | Role::EarlyDef => operand.result.is_some(),
5498        };
5499        let ty = match (operand.result, operand.value) {
5500            (Some(result), _) => self.source[result].ty,
5501            (None, Some(value)) => self.source[value].ty,
5502            (None, None) => return Err(refused()),
5503        };
5504        let bits = held_bits(ty);
5505        if !placeable || self.class_of(ty) != desc.class {
5506            return Err(refused());
5507        }
5508        if let Some((width, stated)) = spelled {
5509            // An operand the template wrote a width on may be written by an instruction that fills
5510            // more of the register than the object in it does, and the object is then the low part
5511            // of what was written. That is what gmp asks for when it counts the low zero bits of a
5512            // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
5513            // the whole register and the `unsigned` is the bottom of it, which is every bit of an
5514            // answer that cannot exceed sixty four anyway.
5515            //
5516            // An operand read at a width the template wrote is the other way round: the object is
5517            // in the register and the instruction looks at the bottom of it. tcc tests the low bits
5518            // of a `size_t` count with `testb $2,%b4`, and every bit that test reads is one the
5519            // object put there.
5520            //
5521            // A write of less of a register than the object fills is right in one case, which is
5522            // an instruction that reads the register it writes and an operand that arrives with
5523            // the object in it. The top of the register is then the top of the object, and the
5524            // instruction leaves it alone. tcc swaps the bytes of an `unsigned` with `xchgb
5525            // %b0,%h0` and a rotate between two of them, and the swap only ever touches the low
5526            // half.
5527            //
5528            // The two that stay refused are a read of more of a register than its type fills,
5529            // which hands an instruction bits nothing ever put there, and a write of less of one
5530            // that nothing carried the object into, which leaves the top of the object holding
5531            // whatever the register held before. An operand the template left plain is refused
5532            // either way, because what gets spelled for that one is the register at the width of
5533            // its type and no other instruction is the one written down.
5534            let carried = matches!(desc.constraint, Constraint::Reuse(_) | Constraint::Fixed(_))
5535                && read_as(list, index).is_some();
5536            // The other case is the one the machine settles by itself: a write of the low four
5537            // bytes of a register clears the four above them, so a sixty four bit object written
5538            // that way holds the thirty two bit answer and nothing else. tcc loads a word through
5539            // `movl 4(%0),%k0` into a `long` and means exactly that.
5540            let cleared = desc.class == self.gpr && width == x86_64::Width::Long && bits == 64;
5541            let widened = stated && desc.role.is_def() && width.bits() > bits;
5542            let narrowed =
5543                stated && width.bits() < bits && (!desc.role.is_def() || carried || cleared);
5544            if bits != width.bits() && !widened && !narrowed {
5545                return Err(refused());
5546            }
5547        }
5548        // An operand the program pinned is in that register and nowhere else, whatever the opcode
5549        // would have allowed it. That is the whole of what a local register variable asks for, and
5550        // it is the same shape a division already has: the allocator is told the register, puts a
5551        // move in front or behind where it has to, and leaves it out where it does not.
5552        let constraint = match pinned(&operand) {
5553            Some(reg) => Constraint::Fixed(reg),
5554            None => desc.constraint,
5555        };
5556        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint })
5557    }
5558
5559    /// A register the template named in its own text.
5560    ///
5561    /// Not one of the statement's operands and not something the allocator handed out. The program
5562    /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
5563    /// something the constraint letters cannot say is made of: micropython saves the callee-saved
5564    /// registers into a buffer by name because the whole point of the buffer is that those exact
5565    /// registers are in it, and there is no constraint letter for `%rsp`.
5566    ///
5567    /// So it is placed as itself, fixed to the register the template named. What that buys is the
5568    /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
5569    /// write of one is a definition it knows about and will not leave anything of the program's
5570    /// across, and a read of one is a use it will not have put something else in first. gcc copies
5571    /// the text out and a register two things believe they own is a wrong program nothing reports.
5572    /// Here the allocator is told, and a program that also named the register in its clobber list
5573    /// says the same thing twice rather than something new.
5574    fn itself(
5575        &mut self,
5576        inst: Inst,
5577        desc: OperandDesc,
5578        reg: PhysReg,
5579    ) -> Result<mir::Operand, Unsupported> {
5580        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5581        if desc.class != self.gpr {
5582            return Err(refused);
5583        }
5584        Ok(mir::Operand {
5585            reg: mir::Reg::physical(reg),
5586            class: self.gpr,
5587            role: desc.role,
5588            constraint: Constraint::Fixed(reg),
5589        })
5590    }
5591
5592    /// A register an instruction of a template uses and the statement put nothing in.
5593    ///
5594    /// A write of one is the register being destroyed, which is what a clobber list is usually
5595    /// written to say and what an instruction with more answers than the program asked for does
5596    /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
5597    /// register of its own is the whole of what that needs, since a value nothing reads is one the
5598    /// allocator may put anywhere and is told about so that nothing else is put there.
5599    ///
5600    /// A read of one is a register the instruction looks at and the program never filled, which
5601    /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
5602    /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
5603    /// zero is the one answer that reads the same on every run.
5604    fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
5605        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5606        if desc.class != self.gpr {
5607            return Err(refused);
5608        }
5609        let reg = self.out.new_vreg(desc.class);
5610        if !desc.role.is_def() {
5611            let block = self.at.expect("a block is being filled");
5612            let span = self.source.span(inst);
5613            let put = self.named("mov_ri_64");
5614            self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
5615        }
5616        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
5617    }
5618
5619    /// The address one instruction of a template reads or writes.
5620    fn addressed(
5621        &mut self,
5622        inst: Inst,
5623        at: x86_64::At,
5624        places: &[Place],
5625        list: &[AsmOperand<'_>],
5626    ) -> Result<mir::Mem, Unsupported> {
5627        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5628        let base = match at.base {
5629            None => None,
5630            Some(x86_64::Piece::Operand { index, .. }) => {
5631                // The register an address is counted from is read and never written, whatever the
5632                // instruction does to what it finds there.
5633                let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5634                Some(mir::Operand::read(reg, self.gpr))
5635            }
5636            // A register the template named, counted from as itself. See [`Self::itself`], and note
5637            // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
5638            // names one register as the thing being stored and another as where to store it. An
5639            // operand a constraint letter put in that register is that operand, for the reason
5640            // [`Self::placed`] gives.
5641            Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
5642                Some(index) => {
5643                    let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5644                    Some(mir::Operand::read(reg, self.gpr))
5645                }
5646                None => Some(
5647                    mir::Operand::read(mir::Reg::physical(reg), self.gpr)
5648                        .with(Constraint::Fixed(reg)),
5649                ),
5650            },
5651            // An address counted from a register the instruction reaches without being told is
5652            // not something this machine has: every addressing mode is written out in the text it
5653            // is part of, so a base that got here another way is a base nothing wrote down.
5654            Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
5655        };
5656        // A distance the template wrote, or the one in an operand the template pointed at, which is
5657        // the same distance said by something that knows how big a thing is. It has to be a number
5658        // the compiler can read at translation time, since it goes in the instruction rather than
5659        // in a register, and an operand holding anything else is refused rather than put somewhere.
5660        let disp = match at.disp {
5661            x86_64::Disp::Number(disp) => disp,
5662            x86_64::Disp::Operand(index) => {
5663                let value =
5664                    list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
5665                let number = self.number(value).ok_or_else(refused)?;
5666                i32::try_from(number).map_err(|_| refused())?
5667            }
5668        };
5669        Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
5670    }
5671
5672    /// The number in that value, for one an `iconst` defined, read at the width of its own type.
5673    ///
5674    /// Signed, because the two things a template asks this for are a distance into an address and
5675    /// the number on an instruction, and both of those are signed wherever they land. A constant
5676    /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
5677    /// which is the same number and is the reading that fits in the thirty two bits an addressing
5678    /// mode has room for.
5679    fn number(&self, value: Value) -> Option<i128> {
5680        let Def::Result { inst, .. } = self.source[value].def else { return None };
5681        if self.source[inst].opcode != Opcode::IConst {
5682            return None;
5683        }
5684        let Extra::Imm(imm) = self.source[inst].extra else { return None };
5685        let bits = self.source[imm].bits();
5686        let width = self.source[value].ty.bits();
5687        if width == 0 || width > 128 {
5688            return None;
5689        }
5690        let spare = 128 - width;
5691        Some(((bits << spare) as i128) >> spare)
5692    }
5693
5694    /// A register holding a value the program has no claim on, written as a zero.
5695    ///
5696    /// Every other way of saying it costs the same instruction or needs a word the machine IR does
5697    /// not have, and a zero is the one that reads the same on every run.
5698    fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
5699        let ty = self.source[result].ty;
5700        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5701        let bits = held_bits(ty);
5702        if self.class_of(ty) != self.gpr || !matches!(bits, 8 | 16 | 32 | 64) {
5703            return Err(refused);
5704        }
5705        let block = self.at.expect("a block is being filled");
5706        let span = self.source.span(inst);
5707        let reg = self.new_reg(result);
5708        let put = self.named(&format!("mov_ri_{bits}"));
5709        self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
5710        Ok(())
5711    }
5712
5713    /// Whether a type is the width an address is, which is what makes a cast to or from one free.
5714    fn is_address_width(&self, ty: Type) -> bool {
5715        ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
5716    }
5717
5718    /// Where a block goes, which in machine IR is on the block rather than on its terminator.
5719    ///
5720    /// That is why no rule ever names a block: a branch is selected for what it reads and the
5721    /// edges are copied across here, arguments and all. The arguments are read last, after every
5722    /// instruction of the block is written, because an argument that is a constant is
5723    /// materialized where it is first wanted and the end of the block is where an edge wants it.
5724    ///
5725    /// Which is not quite the end. A block that leaves two ways has the branch as its last
5726    /// instruction, and a block that leaves through a register has the indirect jump as its last,
5727    /// and anything appended after either is something it has already jumped past, so a constant
5728    /// materialized here would be a register the block below reads and nothing ever writes. The
5729    /// one that was there is put back on the end when that happened, which is the only reordering
5730    /// anything in this crate does and is why it is remembered before a single argument is read.
5731    fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5732        let Some(term) = self.source.terminator(block) else { return Ok(()) };
5733        // An `asm goto` whose template has nothing in it can only fall through, since there is no
5734        // instruction in it to jump with, so the only edge the machine block gets is the first
5735        // one. The labels it names are still arms in the IR, which is what kept the passes above
5736        // from assuming anything about the way into them, and here they are blocks nothing jumps
5737        // to, the same as a label no `goto` names. One that does have instructions was refused by
5738        // [`Self::jumps_from_text`] before this.
5739        if self.source[term].opcode == Opcode::InlineAsm {
5740            let Some(call) = self.source.successors(term).next() else { return Ok(()) };
5741            let args: Vec<Value> = self.source[call.args].to_vec();
5742            let regs =
5743                args.into_iter().map(|value| self.reg_of(value)).collect::<Result<_, _>>()?;
5744            *self.out.succs_mut(out) = vec![mir::BlockCall::with(self.out_block(call.block), regs)];
5745            return Ok(());
5746        }
5747        // A call's unwind edge, which is not an edge of the machine function at all. The branch was
5748        // never written, so what the block has is the arm control takes when the call returns, and
5749        // the pad is a block with nothing in front of it that the call site table is what reaches.
5750        // See [`Self::pad`] for why that is a block the allocator can be handed.
5751        if let Some(unwound) = self.unwind_edge(term) {
5752            let arms: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5753            let next = arms[1];
5754            let args: Vec<Value> = self.source[next.args].to_vec();
5755            let regs =
5756                args.into_iter().map(|value| self.reg_of(value)).collect::<Result<_, _>>()?;
5757            *self.out.succs_mut(out) = vec![mir::BlockCall::with(self.out_block(next.block), regs)];
5758            let call = self.source.prev_inst(unwound).and_then(|call| self.unwinding.get(&call));
5759            if let Some(&call) = call {
5760                let pad = self.out_block(arms[0].block);
5761                self.out.landings.push((call, pad));
5762            }
5763            return Ok(());
5764        }
5765        let leaves =
5766            matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr | Opcode::Switch);
5767        let branch = if leaves { self.out.terminator(out) } else { None };
5768
5769        let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5770        let mut succs = Vec::with_capacity(calls.len());
5771        for call in calls {
5772            let args: Vec<Value> = self.source[call.args].to_vec();
5773            let mut regs = Vec::with_capacity(args.len());
5774            for value in args {
5775                // The address of where the value is rather than the value, for the one type a
5776                // register holds none of. The block on the other side copies the bytes out of it
5777                // into a slot of its own, which is what makes a second edge into the same block
5778                // safe.
5779                let reg = if on_x87(self.source[value].ty) {
5780                    self.x87_slot(value)
5781                } else {
5782                    self.reg_of(value)?
5783                };
5784                regs.push(reg);
5785            }
5786            succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
5787        }
5788        if let Some(branch) = branch {
5789            if self.out.terminator(out) != Some(branch) {
5790                self.out.remove_inst(branch);
5791                self.out.append_inst(out, branch);
5792            }
5793        }
5794        *self.out.succs_mut(out) = succs;
5795        Ok(())
5796    }
5797
5798    /// The `unwound` a branch reads, when the branch is a call's unwind edge.
5799    fn unwind_edge(&self, inst: Inst) -> Option<Inst> {
5800        let data = &self.source[inst];
5801        if data.opcode != Opcode::BrIf {
5802            return None;
5803        }
5804        let &cond = self.source[data.args].first()?;
5805        match self.source[cond].def {
5806            Def::Result { inst, .. } if self.source[inst].opcode == Opcode::Unwound => Some(inst),
5807            _ => None,
5808        }
5809    }
5810
5811    /// The exception a landing pad was entered with, as a copy out of the register the unwinder
5812    /// left it in, which is the first register a value comes back in.
5813    fn landing(&mut self, inst: Inst) -> Result<(), Unsupported> {
5814        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5815        let held = *self.conv.int_returns.first().ok_or_else(|| self.unsupported(inst))?;
5816        let block = self.at.expect("a block is being filled");
5817        let span = self.source.span(inst);
5818        let mov = self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
5819        let mov = self.named(mov.mov);
5820        let into = self.new_reg(result);
5821        self.out
5822            .build(block, mov)
5823            .at(span)
5824            .operand(mir::Operand::write(into, self.gpr))
5825            .operand(
5826                mir::Operand::read(mir::Reg::physical(held), self.gpr)
5827                    .with(Constraint::Fixed(held)),
5828            )
5829            .finish();
5830        Ok(())
5831    }
5832
5833    /// Makes a landing pad a block that reads nothing from the blocks around it, and says what to
5834    /// put back once it has been filled.
5835    ///
5836    /// The pad has no machine block in front of it, because the edge into it is not one the machine
5837    /// takes: control arrives from the unwinder, with the registers the frame rules at the call put
5838    /// back. So nothing the allocator keeps in a register can reach it, and a value it reads from
5839    /// elsewhere is made again inside it. What a pad reads is the address of each object a handler
5840    /// is owed, which is a slot of the frame, the address of a name, or a constant, and each of
5841    /// those can be written a second time from nothing. Anything else is refused.
5842    ///
5843    /// The registers the rest of the function knows those values by are put back afterwards,
5844    /// which is what the answer is for: the pad's copies are its own.
5845    fn pad(&mut self, block: Block) -> Result<Vec<(Value, Option<mir::Reg>)>, Unsupported> {
5846        let mut kept = Vec::new();
5847        let first = self.source.insts(block).next();
5848        if !first.is_some_and(|inst| self.source[inst].opcode == Opcode::Landing) {
5849            return Ok(kept);
5850        }
5851        let out = self.at.expect("a block is being filled");
5852        let insts: Vec<Inst> = self.source.insts(block).collect();
5853        for inst in insts {
5854            let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
5855            for value in args {
5856                let Def::Result { inst: def, .. } = self.source[value].def else {
5857                    return Err(self.unsupported(inst));
5858                };
5859                if self.source.block_of(def) == Some(block)
5860                    || kept.iter().any(|&(done, _)| done == value)
5861                {
5862                    continue;
5863                }
5864                match self.source[def].opcode {
5865                    Opcode::IConst => {}
5866                    Opcode::Alloca => {
5867                        let &index =
5868                            self.frame_slots.get(&value).ok_or_else(|| self.unsupported(def))?;
5869                        kept.push((value, self.regs[value.index()]));
5870                        let reg = self.out.new_vreg(self.gpr);
5871                        self.regs[value.index()] = Some(reg);
5872                        let lea = self.named(self.selector.frame.lea);
5873                        let sp = mir::Reg::physical(self.conv.stack_pointer);
5874                        let sp = mir::Operand::read(sp, self.gpr);
5875                        let span = self.source.span(def);
5876                        let made = self
5877                            .out
5878                            .build(out, lea)
5879                            .at(span)
5880                            .def(reg, self.gpr)
5881                            .mem(mir::Mem::at(sp))
5882                            .finish();
5883                        self.stack.addresses.push((made, index));
5884                    }
5885                    Opcode::GlobalAddr => {
5886                        kept.push((value, self.regs[value.index()]));
5887                        self.regs[value.index()] = None;
5888                        self.address_of(def)?;
5889                    }
5890                    _ => return Err(self.unsupported(def)),
5891                }
5892            }
5893        }
5894        Ok(kept)
5895    }
5896
5897    /// Whether an `asm goto` has instructions in its template, which is what it would jump with.
5898    ///
5899    /// One with an empty template is what a program writes to tell the optimizer that control may
5900    /// arrive at a label without saying how, and the torture suite has several of them. It never
5901    /// jumps, so it is written as the statement it would be without its labels and a fall through
5902    /// into its first arm. See [`Self::edges`]. One with anything in it needs the labels it names
5903    /// written into the text and an edge for each of them the allocator knows about, and that is
5904    /// still refused.
5905    fn jumps_from_text(&self, inst: Inst) -> bool {
5906        let Extra::Asm(asm) = self.source[inst].extra else { return false };
5907        let info = self.source[asm];
5908        !self.source[info.targets].is_empty()
5909            && !self.names.resolve(info.template).trim().is_empty()
5910    }
5911
5912    /// The machine IR block an IR block became.
5913    fn out_block(&self, block: Block) -> mir::Block {
5914        self.blocks[block.index()].expect("every block was created before any was filled")
5915    }
5916
5917    /// The parameters of the entry block, which are the function's arguments.
5918    ///
5919    /// They are not block parameters in the machine IR and they cannot be. A block parameter is
5920    /// given its value by a move on the edge into the block, and there is no edge into an entry
5921    /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
5922    /// says it.
5923    ///
5924    /// The ones past the last register arrived in the caller's memory and are read out of it, and
5925    /// the loads that read them come back here so that the frame can finish them the way it
5926    /// finishes an `alloca`.
5927    fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5928        let params = self.source[block].params.clone();
5929        // The type of each is the block's answer and what the ABI asks of it is the signature's,
5930        // and the two lists are the same list: a parameter the classification turned into a
5931        // pointer is a pointer in the block too. A block with more parameters than the signature
5932        // names is not one the front end writes, and each of those is taken as a plain value.
5933        let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
5934        let types: Vec<Param> = params
5935            .iter()
5936            .enumerate()
5937            .map(|(index, &value)| {
5938                let abi = asked.get(index).copied().unwrap_or_default();
5939                Param { ty: self.source[value].ty, abi }
5940            })
5941            .collect();
5942        // A save area for a function that takes arguments its signature does not name, which is a
5943        // block of this function's frame on one convention and the shadow space the caller already
5944        // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
5945        // [`Self::save_area`] is where the difference is spent.
5946        //
5947        // Apple's AArch64 is neither. Every argument a signature does not name is in the caller's
5948        // memory, so there is nothing to save and the list starts at the first word past the named
5949        // ones.
5950        //
5951        // A function holding `__builtin_apply_args` asks for the same area whether it is variadic
5952        // or not, because what it saves is every argument register, and the area is where the
5953        // walk that binds them says where each one goes.
5954        let variadic = self.source.signature().variadic;
5955        let in_memory = self.conv.abi.variadic == Variadic::AlwaysMemory;
5956        let applies = self.saves_arguments();
5957        let area = (variadic && !in_memory || applies).then(|| varargs::Area::of(self.conv));
5958        let arrived =
5959            abi::entry(&mut self.out, out, &types, self.conv, self.selector.abi, self.names, area)
5960                .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
5961        for (&param, reg) in params.iter().zip(&arrived.regs) {
5962            self.regs[param.index()] = Some(*reg);
5963        }
5964        if applies {
5965            self.save_arguments(out, &arrived);
5966        }
5967        // A variadic function of the convention the platform does not call its own has no list
5968        // this can start. Its `va_list` would have to be the other platform's, which is a type C
5969        // has no name for here, and the front end refuses a definition with `...` in it for that
5970        // reason. What is left is an old style definition, which is variadic to a caller and has
5971        // no `...` for a `va_start` to follow, so nothing is set up and a `va_start` that reached
5972        // here all the same would be refused rather than read the wrong list.
5973        let foreign = self.source.signature().convention != Convention::Target;
5974        let variadic = variadic && !foreign;
5975        if let (true, Some(area)) = (variadic && !in_memory, area) {
5976            self.save_area(out, &arrived, area);
5977        } else if variadic {
5978            let incoming = arrived.beyond.next_multiple_of(self.conv.word);
5979            self.varargs = Some(Varargs::Pointer { incoming });
5980        }
5981        self.stack.arguments.extend(arrived.stack);
5982        Ok(())
5983    }
5984
5985    /// The prologue of a variadic function, which is every argument register it was handed written
5986    /// into the frame.
5987    ///
5988    /// Every one the signature did not name, that is. Which of those hold anything is a thing only
5989    /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
5990    /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
5991    /// ever reads their slots.
5992    ///
5993    /// What that costs is up to fourteen stores in the prologue of a function that may read none of
5994    /// them, and the convention's answer to that is the count of vector registers in `%al`, which
5995    /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
5996    /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
5997    /// has no blocks to branch between. So they are all written every time, which is correct and is
5998    /// what `-O0` costs. Issue #323 is the branch.
5999    ///
6000    /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
6001    /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
6002    /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
6003    ///
6004    /// The address is computed once into a register rather than written as a displacement off the
6005    /// stack pointer, because a displacement into a frame is not known until after allocation and
6006    /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
6007    /// gets and [`crate::finish`] fills it in the same way.
6008    ///
6009    /// A convention that homes its register arguments has none of that. Its area is the shadow
6010    /// space the caller reserved above the return address, so there is no object to make and no
6011    /// address to work out: each store reaches into the caller's argument area the way the load of
6012    /// a parameter the registers ran out before does, which is the same waiting list and the same
6013    /// fixup. There are at most four of them and none is a vector register, since a float the
6014    /// signature does not name arrived in a general purpose register too and that is the copy the
6015    /// walk reads.
6016    fn save_area(&mut self, out: mir::Block, arrived: &abi::Arrived, area: varargs::Area) {
6017        if self.conv.shared_positions {
6018            self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
6019            let store = self.named("mov_mr_64");
6020            for &(reg, class, at) in &arrived.spare {
6021                let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
6022                let made =
6023                    self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
6024                self.stack.arguments.push((made, at));
6025            }
6026            return;
6027        }
6028
6029        let save = self.stack.locals.len();
6030        self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
6031        let took = |count: usize, float: bool| {
6032            let count = u32::try_from(count).unwrap_or(0).min(area.holds(float));
6033            area.starts_at(float) + count * area.stride(float)
6034        };
6035        let integers = took(arrived.took.0, false);
6036        let floats = took(arrived.took.1, true);
6037        self.varargs = Some(if self.conv.list == VaList::Aapcs {
6038            // Minus what is left of each half, since the two offsets count up to its top.
6039            let left = |at: u32, float: bool| {
6040                i32::try_from(at).unwrap_or(0) - i32::try_from(area.ends_at(float)).unwrap_or(0)
6041            };
6042            Varargs::Aapcs {
6043                save,
6044                incoming: arrived.beyond,
6045                integers_end: area.ends_at(false),
6046                floats_end: area.ends_at(true),
6047                integers: left(integers, false),
6048                floats: left(floats, true),
6049            }
6050        } else {
6051            Varargs::Fields { save, incoming: arrived.beyond, integers, floats }
6052        });
6053
6054        // A vector register is saved all sixteen bytes wide, as a quad is, whatever it held.
6055        let base = self.frame_address(out, save);
6056        for &(reg, class, at) in &arrived.spare {
6057            let ty =
6058                if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
6059            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6060            let store = mir::Opcode::new(self.names.intern(head));
6061            let up = i32::try_from(at).expect("a register save area under two gigabytes");
6062            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
6063            self.out.build(out, store).uses(reg, class).mem(mem).finish();
6064        }
6065    }
6066
6067    /// Whether the function holds a `__builtin_apply_args`, on a convention this can save the
6068    /// arguments of.
6069    ///
6070    /// Only the one that keeps the two register files apart and saves them the way a SysV list
6071    /// does, since the block is that layout with one word in front of it. On any other the call is
6072    /// refused where it stands, which is [`Self::apply_args`] finding nothing saved.
6073    fn saves_arguments(&self) -> bool {
6074        if self.conv.list != VaList::SysV || self.conv.shared_positions {
6075            return false;
6076        }
6077        let source = self.source;
6078        source
6079            .blocks()
6080            .any(|block| source.insts(block).any(|inst| source[inst].opcode == Opcode::ApplyArgs))
6081    }
6082
6083    /// The prologue of a function holding `__builtin_apply_args`, which is every argument register
6084    /// it was handed and where the arguments in memory start, written into a block of its frame.
6085    ///
6086    /// The block is the one gcc lays out on this convention, so that a program reading it the way
6087    /// gcc's manual says reads the same bytes:
6088    ///
6089    /// ```text
6090    ///   0        where the arguments that came in memory are
6091    ///   8        nothing, so that what follows is sixteen byte aligned
6092    ///   16..64   the six general purpose argument registers, a word each
6093    ///   64..192  the eight vector argument registers, sixteen bytes each
6094    /// ```
6095    ///
6096    /// Which is the register save area of a variadic function with a word and a pad in front, so
6097    /// the offsets are that area's plus sixteen. What is different is that every register is
6098    /// written and not only the ones no parameter took: the one a parameter arrived in is written
6099    /// from the register the parameter was bound to, which holds it untouched because nothing has
6100    /// run yet, and the rest from the pseudos the walk made for them.
6101    fn save_arguments(&mut self, out: mir::Block, arrived: &abi::Arrived) {
6102        let applied = self.stack.locals.len();
6103        self.stack.locals.push(Local { size: APPLY_ARGS, align: varargs::VECTOR_SLOT });
6104        self.applied = Some(applied);
6105        let base = self.frame_address(out, applied);
6106        let overflow = self.overflow(out, 0, Span::DUMMY);
6107        let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
6108        let store = mir::Opcode::new(self.names.intern(head));
6109        let mem = mir::Mem::at(mir::Operand::read(base, self.gpr));
6110        self.out.build(out, store).uses(overflow, self.gpr).mem(mem).finish();
6111
6112        let named = arrived.named.iter().map(|&(index, at)| {
6113            let reg = arrived.regs[index];
6114            let class = self.out.class_of(reg).unwrap_or(self.gpr);
6115            (reg, class, at)
6116        });
6117        let every: Vec<_> = named.chain(arrived.spare.iter().copied()).collect();
6118        for (reg, class, at) in every {
6119            let ty =
6120                if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
6121            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6122            let store = mir::Opcode::new(self.names.intern(head));
6123            let up = i32::try_from(at + APPLY_REGS).expect("a block of under two gigabytes");
6124            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
6125            self.out.build(out, store).uses(reg, class).mem(mem).finish();
6126        }
6127    }
6128
6129    /// One `__builtin_apply_args`, which is the address of the block the prologue wrote.
6130    fn apply_args(&mut self, inst: Inst) -> Result<(), Unsupported> {
6131        let Some(applied) = self.applied else { return Err(self.unsupported(inst)) };
6132        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6133        let block = self.at.expect("a block is being filled");
6134        let reg = self.frame_address(block, applied);
6135        self.regs[result.index()] = Some(reg);
6136        Ok(())
6137    }
6138
6139    /// One `__builtin_apply`, which is a call whose arguments are every register in a block
6140    /// `__builtin_apply_args` answered and some bytes of the memory it says the arguments in
6141    /// memory were in.
6142    ///
6143    /// Built as a call of fourteen arguments, six words and eight vectors, which puts each in the
6144    /// register it came out of, and one object of the size the program gave, which is copied into
6145    /// the bottom of the outgoing area the way a structure passed by value is. The call is made as
6146    /// to a variadic function, so the count of vector registers is eight and a variadic callee
6147    /// saves all of them.
6148    ///
6149    /// What comes back is every register a value can come back in, which is two of each file, and
6150    /// they are written into a block of this function's frame whose address is the answer: the two
6151    /// words at 0 and 8 and the two vectors at 16 and 32. An eighty bit value comes back on the x87
6152    /// stack and is not in it, which is the one thing gcc's block holds that this one does not.
6153    fn apply(&mut self, inst: Inst) -> Result<(), Unsupported> {
6154        if self.conv.list != VaList::SysV || self.conv.shared_positions {
6155            return Err(self.unsupported(inst));
6156        }
6157        let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
6158        let [function, saved, size] = values[..] else { return Err(self.unsupported(inst)) };
6159        let size = self.number(size).ok_or_else(|| self.unsupported(inst))?;
6160        let size = u32::try_from(size).map_err(|_| self.unsupported(inst))?;
6161        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6162        let function = self.reg_of(function)?;
6163        let saved = self.reg_of(saved)?;
6164        let block = self.at.expect("a block is being filled");
6165        let span = self.source.span(inst);
6166
6167        let word = Type::int(64);
6168        let vector = Type::float(rucc_ir::Float::F128);
6169        let area = varargs::Area::of(self.conv);
6170        let load = |ty: Type| (self.selector.abi.load)(ty).expect("a load of a whole register");
6171        let (load_word, load_vector) = (load(word), load(vector));
6172        let mut read = |ty: Type, head: &str, class: RegClass, at: u32| {
6173            let reg = self.out.new_vreg(class);
6174            let opcode = mir::Opcode::new(self.names.intern(head));
6175            let at = i32::try_from(at).expect("a block of under two gigabytes");
6176            let mem = mir::Mem::at(mir::Operand::read(saved, self.gpr)).plus(at);
6177            self.out.build(block, opcode).at(span).def(reg, class).mem(mem).finish();
6178            abi::Passing { ty, reg, abi: Abi::Plain }
6179        };
6180        let sse = self.conv.sse_class;
6181        let gpr = self.gpr;
6182        let mut args = Vec::with_capacity(15);
6183        for (float, ty, head, class) in
6184            [(false, word, load_word, gpr), (true, vector, load_vector, sse)]
6185        {
6186            for index in 0..area.holds(float) {
6187                let at = APPLY_REGS + area.starts_at(float) + index * area.stride(float);
6188                args.push(read(ty, head, class, at));
6189            }
6190        }
6191        if size > 0 {
6192            let memory = read(word, load_word, gpr, 0);
6193            let object =
6194                Abi::ByVal { size: u64::from(size), align: 8, drains: rucc_ir::Drains::Nothing };
6195            args.push(abi::Passing { abi: object, ..memory });
6196        }
6197        let returns = [word, word, vector, vector];
6198        let what = abi::Calling {
6199            callee: abi::Callee::Through(function),
6200            args: &args,
6201            returns: &returns,
6202            variadic: true,
6203            named: args.len(),
6204            at: span,
6205        };
6206        let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
6207            .map_err(|refused| Unsupported::Call { inst, refused })?;
6208        let calls = &mut self.stack.calls;
6209        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
6210
6211        let back = self.stack.locals.len();
6212        self.stack.locals.push(Local { size: APPLY_BACK, align: varargs::VECTOR_SLOT });
6213        let base = self.frame_address(block, back);
6214        for ((&reg, ty), at) in made.results.iter().zip(returns).zip([0, 8, 16, 32]) {
6215            let class = if ty == word { gpr } else { sse };
6216            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
6217            let store = mir::Opcode::new(self.names.intern(head));
6218            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(at);
6219            self.out.build(block, store).at(span).uses(reg, class).mem(mem).finish();
6220        }
6221        let answer = self.frame_address(block, back);
6222        self.regs[result.index()] = Some(answer);
6223        Ok(())
6224    }
6225
6226    /// The address of one of the function's stack objects, in a fresh register.
6227    ///
6228    /// Written with nothing in its displacement, because where an object is in a frame is not known
6229    /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
6230    fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
6231        self.frame_address_plus(out, local, 0)
6232    }
6233
6234    /// The address some way into a local, which the frame finishes the same way, adding where the
6235    /// local is to what is already there.
6236    fn frame_address_plus(&mut self, out: mir::Block, local: usize, plus: u32) -> mir::Reg {
6237        let reg = self.out.new_vreg(self.gpr);
6238        let lea = self.named(self.selector.frame.lea);
6239        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
6240        let plus = i32::try_from(plus).expect("an offset into a local under two gigabytes");
6241        let mem = mir::Mem::at(sp).plus(plus);
6242        let made = self.out.build(out, lea).def(reg, self.gpr).mem(mem).finish();
6243        self.stack.addresses.push((made, local));
6244        reg
6245    }
6246
6247    /// Whether an instruction is one no machine instruction is written for where it stands.
6248    ///
6249    /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
6250    /// written where a register for it is first wanted rather than where the IR put it, and every
6251    /// reader of one may have folded it into an immediate, in which case nowhere is the right
6252    /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
6253    /// and leaves, and it is appended to every block with no successors long after this has
6254    /// finished, so a return with a value is one instruction here and a return without one is
6255    /// none. Unless the value went back through memory, in which case there is something to put
6256    /// somewhere after all and the IR does not carry it: the address the caller handed over has
6257    /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
6258    ///
6259    /// An unconditional jump is the third, and there is even less of it: the edge is on the
6260    /// block, and whether the block it goes to is the next one and needs no jump at all is the
6261    /// block layout's answer rather than this one's.
6262    ///
6263    /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
6264    /// the `unreachable` terminator the front end puts at the end of a function whose body can run
6265    /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
6266    /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
6267    /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
6268    /// successors, so the epilogue lands at the end of it the way it does on any other block that
6269    /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
6270    /// the assembler puts next.
6271    fn writes_nothing(&self, inst: Inst) -> bool {
6272        let data = &self.source[inst];
6273        match data.opcode {
6274            Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
6275            // The question of whether a call unwound and the branch on its answer, neither of which
6276            // is an instruction. See [`Self::edges`].
6277            Opcode::Unwound => true,
6278            Opcode::BrIf => self.unwind_edge(inst).is_some(),
6279            Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
6280            _ => false,
6281        }
6282    }
6283
6284    /// What every instruction in one block matched, with a set of values nobody may take.
6285    ///
6286    /// Backwards, because an instruction that has been folded into a later one does not get to
6287    /// fold anything into itself: the rule that took it only reached one level down, so what is
6288    /// under it is not in the term the matcher saw and cannot be replaced.
6289    fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
6290        let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
6291        let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
6292        let mut folded: Vec<Inst> = Vec::new();
6293        for (index, &inst) in insts.iter().enumerate().rev() {
6294            if folded.contains(&inst) {
6295                continue;
6296            }
6297            if let Some((plan, matched)) = self.select(inst, refused) {
6298                folded.extend(self.folds(inst, plan));
6299                found[index] = Some(matched);
6300                plans[index] = Some(plan);
6301            }
6302        }
6303        Decided { found, plans, folded }
6304    }
6305
6306    /// A value some of its readers took and some of them did not, which is the one case folding
6307    /// buys nothing.
6308    ///
6309    /// Folding does not delete the instruction that computed a value for anybody else, so a
6310    /// reader that did not take it still needs it in a register and the instruction stays. The
6311    /// reader that did take it now does that work again. Either all of them take it, in which
6312    /// case nothing is left to read it and the instruction goes, or none of them do.
6313    ///
6314    /// The count is over the whole function rather than over the block, since a value read from
6315    /// another block is read from a register there whatever this block decides. An instruction
6316    /// built by name rather than matched, a call being the one that matters, has no plan and so
6317    /// takes nothing, which is the right answer for it as well.
6318    ///
6319    /// The count is kept only for the values this block's instructions take. It used to be a slot
6320    /// for every value in the function, cleared for every block, and on a function of thirty
6321    /// thousand blocks and a hundred and seventy thousand values that clearing was four percent of
6322    /// an optimized compile.
6323    fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
6324        let mut taken: HashMap<Value, u32> = HashMap::new();
6325        for (&inst, plan) in insts.iter().zip(plans) {
6326            let Some(plan) = plan else { continue };
6327            let args = &self.source[self.source[inst].args];
6328            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
6329                if plan[index] == Shown::Expand {
6330                    *taken.entry(arg).or_default() += 1;
6331                }
6332            }
6333        }
6334        for (&inst, plan) in insts.iter().zip(plans) {
6335            let Some(plan) = plan else { continue };
6336            let args = &self.source[self.source[inst].args];
6337            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
6338                if plan[index] == Shown::Expand && taken[&arg] < self.uses[arg.index()] {
6339                    return Some(arg);
6340                }
6341            }
6342        }
6343        None
6344    }
6345
6346    /// The rule that fires on an instruction, and what it bound.
6347    ///
6348    /// The plans are tried in order and the first that matches wins, which is the maximal munch
6349    /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
6350    /// that offers less.
6351    fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
6352        for plan in self.plans(inst, refused) {
6353            let terms = Terms::new(self.source, inst, plan);
6354            if let Some(matched) = self.selector.table.find(&terms, Term::Root) {
6355                return Some((plan, matched));
6356            }
6357        }
6358        None
6359    }
6360
6361    /// Every way this instruction can be shown to the matcher, most offered first.
6362    ///
6363    /// That is every choice of a way to show each operand, with the choice for the first operand
6364    /// changing slowest. The plans are counted out rather than collected, because this is asked
6365    /// for every instruction that is selected and the lists it used to build were an allocation
6366    /// or two per operand.
6367    fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> impl Iterator<Item = Plan> {
6368        let args = &self.source[self.source[inst].args];
6369        let mut ways = [[Shown::Reg; 3]; MAX_ARGS];
6370        let mut counts = [1; MAX_ARGS];
6371        for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
6372            let mut count = 0;
6373            if self.foldable(inst, arg, refused) {
6374                ways[index][count] = Shown::Expand;
6375                count += 1;
6376            }
6377            if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
6378                ways[index][count] = Shown::Const;
6379                count += 1;
6380            }
6381            ways[index][count] = Shown::Reg;
6382            counts[index] = count + 1;
6383        }
6384        (0..counts.iter().product()).map(move |mut number: usize| {
6385            let mut plan = PLAIN;
6386            for index in (0..MAX_ARGS).rev() {
6387                plan[index] = ways[index][number % counts[index]];
6388                number /= counts[index];
6389            }
6390            plan
6391        })
6392    }
6393
6394    /// Whether an operand may be shown as the instruction that computed it.
6395    ///
6396    /// It has to be in the same block, because a rule that folds one instruction into another
6397    /// moves the work to where the second one is. It has to be something rather than a block
6398    /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
6399    /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
6400    /// question is asked here: this says yes to a value with any number of readers, and a value
6401    /// only some of them could take is refused after the fact and asked again.
6402    ///
6403    /// A value with several readers used to be refused outright, on the reasoning that folding
6404    /// does not delete the instruction for anybody else. That reasoning is about the set of
6405    /// readers and was being applied to one reader at a time, which is stricter than it needs to
6406    /// be: when every reader takes it there is nobody left to read it and the instruction goes.
6407    /// An address a store and a load share is the shape that matters, since a memory operand has
6408    /// room for the whole of it and both readers have a memory operand.
6409    fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
6410        let Def::Result { inst, .. } = self.source[value].def else { return false };
6411        if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
6412            return false;
6413        }
6414        self.source.block_of(inst).is_some()
6415            && self.source.block_of(inst) == self.source.block_of(into)
6416    }
6417
6418    /// The instructions a match folded into the one it matched.
6419    ///
6420    /// The plan is what says this, not the bindings: a binding is a register or a number either
6421    /// way, and an operand shown as the instruction that computed it is one no rule could have
6422    /// matched without taking that instruction, because the plan offered the matcher nothing
6423    /// else to call it.
6424    fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
6425        let args = &self.source[self.source[inst].args];
6426        args.iter()
6427            .take(MAX_ARGS)
6428            .enumerate()
6429            .filter(|&(index, _)| plan[index] == Shown::Expand)
6430            .filter_map(|(_, &arg)| match self.source[arg].def {
6431                Def::Result { inst, .. } => Some(inst),
6432                Def::Param { .. } => None,
6433            })
6434            .collect()
6435    }
6436
6437    /// What the IR instruction said about itself that the machine instruction has to keep saying.
6438    ///
6439    /// One flag today. `volatile` says the access happens exactly once and is never moved or
6440    /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
6441    /// one are the same instruction over the same address, so a pass that puts two accesses
6442    /// together would put these together too. Carried rather than checked here, because the pass
6443    /// that has to refuse is a long way down and this is the last place the answer is known.
6444    ///
6445    /// The instructions this compiler writes for itself get nothing, which is the right answer
6446    /// for all of them: a prologue, a spill and the moves around a call were asked for by the
6447    /// machine rather than by the program.
6448    ///
6449    /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
6450    /// the two ends of a `long double` copy that are the program's own memory, and the compare
6451    /// and exchange and the read modify write. An `asm` statement does not, and it is the one
6452    /// exception on purpose. What the flag says there is that the statement stays even when
6453    /// nothing reads what it wrote, which is a different sentence about a different thing, and
6454    /// every `asm` is already fixed where it stands whether the word was written or not.
6455    fn carried(&self, inst: Inst) -> mir::Flags {
6456        if self.source[inst].flags.contains(Flags::VOLATILE) {
6457            mir::Flags::VOLATILE
6458        } else {
6459            mir::Flags::NONE
6460        }
6461    }
6462
6463    /// Build the machine instructions a match calls for.
6464    fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
6465        let rule: &Rule = self.selector.table.rule(matched);
6466        self.build(inst, rule.replacement, 0, &matched.bindings, true).map(|_| ())
6467    }
6468
6469    /// Build the machine term that starts at `at`, and give back the position after it and the
6470    /// register it wrote, if it wrote one.
6471    ///
6472    /// The outermost term computes what the IR instruction does, so what it writes is the
6473    /// register of the instruction's result. A term inside another is a step on the way and
6474    /// writes a register of its own, which the term around it then reads. Its operands are read
6475    /// before it is built and it is built before the term around it, so the instructions come
6476    /// out in the order the values are needed.
6477    fn build(
6478        &mut self,
6479        inst: Inst,
6480        pieces: &'static [Piece],
6481        at: usize,
6482        bindings: &[Term],
6483        outermost: bool,
6484    ) -> Result<(usize, Option<mir::Reg>), Unsupported> {
6485        let Some(Piece::App { head, arity }) = pieces.get(at) else {
6486            return Err(self.unsupported(inst));
6487        };
6488        let opcode =
6489            head.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
6490        let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
6491
6492        let mut read = Read::default();
6493        let mut at = at + 1;
6494        for _ in 0..*arity {
6495            at = self.read(inst, pieces, at, bindings, &mut read)?;
6496        }
6497
6498        let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
6499        if descs.len() - writes != read.regs.len() {
6500            return Err(self.unsupported(inst));
6501        }
6502
6503        // The first thing the instruction writes is what it computes, and any others are
6504        // registers the machine destroys on the way, which are fresh because nothing else is in
6505        // them and nothing reads them. An instruction that writes nothing at all is one whose
6506        // whole purpose is its effect, which is what a store is, and there is no result to put
6507        // anywhere.
6508        let mut regs = Vec::new();
6509        if writes > 0 {
6510            // A term inside another computes a step rather than the result, into a register only
6511            // the term around it reads.
6512            let first = match outermost {
6513                true => {
6514                    let result =
6515                        self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6516                    self.new_reg(result)
6517                }
6518                false => self.out.new_vreg(descs[0].class),
6519            };
6520            regs.push(first);
6521            // The rest are the registers the machine destroys on the way, and the class each is in
6522            // is the one the instruction's description gives it rather than a guess, so that an
6523            // instruction that wrecks a register in the other file says so.
6524            regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
6525        } else if !outermost || self.source[inst].first_result.is_some() {
6526            // A rule that throws away a value the IR gave a name to would leave every reader of
6527            // that name with nothing to read, so it is a rule this and the target disagree about.
6528            // So is a term inside another that writes nothing for the one around it to read.
6529            return Err(self.unsupported(inst));
6530        }
6531        let written = regs.first().copied();
6532        regs.extend(read.regs.iter().copied());
6533
6534        let block = self.at.expect("a block is being filled");
6535        let opcode = mir::Opcode::new(self.names.intern(head));
6536        let (span, flags) = (self.source.span(inst), self.carried(inst));
6537        let mut build = self.out.build(block, opcode).at(span).flags(flags);
6538        for (desc, reg) in descs.iter().zip(regs) {
6539            let operand = mir::Operand {
6540                reg,
6541                class: desc.class,
6542                role: desc.role,
6543                constraint: desc.constraint,
6544            };
6545            build = build.operand(operand);
6546        }
6547        if let Some(mem) = read.mem {
6548            build = build.mem(mem);
6549        }
6550        if let Some(imm) = read.imm {
6551            build = build.imm(imm);
6552        }
6553        build.finish();
6554        Ok((at, written))
6555    }
6556
6557    /// Read one argument of a replacement, which is a register, a number, an address or another
6558    /// machine term.
6559    ///
6560    /// Gives back the position after it, because a replacement is flat and an address or a term
6561    /// takes arguments of its own. A machine term is built on the spot, and what is read is the
6562    /// register it wrote.
6563    fn read(
6564        &mut self,
6565        inst: Inst,
6566        pieces: &'static [Piece],
6567        at: usize,
6568        bindings: &[Term],
6569        out: &mut Read,
6570    ) -> Result<usize, Unsupported> {
6571        match pieces.get(at) {
6572            Some(Piece::Int(value)) => {
6573                out.imm = i64::try_from(*value).ok();
6574                Ok(at + 1)
6575            }
6576            // A number the rule worked out of the ones it matched rather than one it wrote down,
6577            // which is an immediate once it has been worked out and is read here as one. It gives
6578            // nothing back when a binding it reads is a register, and a replacement that cannot be
6579            // built is a rule this file and the matcher disagree about, which is what `unsupported`
6580            // is for.
6581            Some(Piece::Computed { work, .. }) => {
6582                let matched: Vec<Option<i128>> = bindings
6583                    .iter()
6584                    .map(|term| match *term {
6585                        Term::Num(value) => Some(value),
6586                        _ => None,
6587                    })
6588                    .collect();
6589                let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
6590                out.imm = i64::try_from(number).ok();
6591                Ok(at + 1)
6592            }
6593            Some(Piece::Var { index, .. }) => {
6594                match bindings.get(*index) {
6595                    Some(&Term::Reg(value)) => {
6596                        let reg = self.reg_of(value)?;
6597                        out.regs.push(reg);
6598                    }
6599                    Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
6600                    // A pattern binds a register or a number and nothing else, so this is a
6601                    // rule the matcher and this file disagree about.
6602                    _ => return Err(self.unsupported(inst)),
6603                }
6604                Ok(at + 1)
6605            }
6606            Some(Piece::App { head, .. }) if (self.selector.address)(head).is_none() => {
6607                let (next, reg) = self.build(inst, pieces, at, bindings, false)?;
6608                out.regs.push(reg.ok_or_else(|| self.unsupported(inst))?);
6609                Ok(next)
6610            }
6611            Some(Piece::App { head, arity }) => {
6612                let kind = (self.selector.address)(head).ok_or_else(|| self.unsupported(inst))?;
6613                let mut inner = Read::default();
6614                let mut next = at + 1;
6615                for _ in 0..*arity {
6616                    next = self.read(inst, pieces, next, bindings, &mut inner)?;
6617                }
6618                let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
6619                out.mem = Some(mem);
6620                Ok(next)
6621            }
6622            None => Err(self.unsupported(inst)),
6623        }
6624    }
6625
6626    /// The register a value is in, materializing it if it is a constant that has not been put in
6627    /// one yet.
6628    ///
6629    /// A constant is written where it is wanted rather than where the IR defined it, and where it
6630    /// is wanted is a block that need not be the one the IR defined it in. So the register holding
6631    /// one is only good inside the block it was written into, and a second block that wants the
6632    /// same constant gets its own. Anything else is a register read where nothing wrote it: the
6633    /// IR guarantees a definition dominates its uses, and this moved the definition.
6634    ///
6635    /// Writing the number again is also the right answer and not merely the safe one. It is one
6636    /// instruction that reads nothing, which is cheaper than holding a register live across a
6637    /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
6638    fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
6639        let constant = match self.source[value].def {
6640            Def::Result { inst, .. } => {
6641                (self.source[inst].opcode == Opcode::IConst).then_some(inst)
6642            }
6643            Def::Param { .. } => None,
6644        };
6645        let here = self.at.expect("a block is being filled");
6646        if let Some(reg) = self.regs[value.index()] {
6647            if constant.is_none() || self.written[value.index()] == Some(here) {
6648                return Ok(reg);
6649            }
6650        }
6651        if let Some(inst) = constant {
6652            // Cleared so that the register the constant is written into is a new one rather than
6653            // the one the block above wrote, which is still being read up there.
6654            self.regs[value.index()] = None;
6655            // Nothing is refused here. A constant is written on its own, out of the loop over the
6656            // block, and the operands of the rule that writes one are the number and nothing else.
6657            let matched = self
6658                .select(inst, &HashSet::new())
6659                .map(|(_, matched)| matched)
6660                .ok_or_else(|| self.unsupported(inst))?;
6661            self.emit(inst, &matched)?;
6662            // The same mark the loop over the instructions makes, and it has to be made here as
6663            // well because this is the only place a constant is ever selected: the loop skips one
6664            // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
6665            // would be reported as a rule nothing reaches.
6666            self.fired.mark(matched.rule);
6667            self.written[value.index()] = Some(here);
6668            return Ok(self.regs[value.index()].expect("a constant is written into a register"));
6669        }
6670        Ok(self.new_reg(value))
6671    }
6672
6673    /// Which register file a value of that type lives in.
6674    ///
6675    /// The vector one for the two float widths the machine has scalar instructions for and for the
6676    /// one it only moves, and the general purpose one for everything else. An eighty bit `long
6677    /// double` is in neither, and it is here rather than in the vector class on purpose: it would
6678    /// be put in a register that cannot hold it, and there is no rule that names one, so the
6679    /// instruction computing it is reported. The wrong class would make that a wrong program
6680    /// instead of a refused one.
6681    ///
6682    /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
6683    /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
6684    /// what the class buys is the moves: a register that holds the whole value is a register a
6685    /// spill, a reload and a copy are each one instruction for.
6686    fn class_of(&self, ty: Type) -> RegClass {
6687        if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
6688    }
6689
6690    /// A fresh register for a value, which is what the instruction computing it writes.
6691    ///
6692    /// Any declaration the value is a value of comes with it. Here rather than once at the end over
6693    /// the whole map, because a constant is written again in every block that wants one and the map
6694    /// only remembers the last of those registers, and a local held in a constant is a local that
6695    /// would otherwise be findable in one block of the function and nowhere else.
6696    fn new_reg(&mut self, value: Value) -> mir::Reg {
6697        if let Some(reg) = self.regs[value.index()] {
6698            return reg;
6699        }
6700        let ty = self.source[value].ty;
6701        let reg = self.out.new_vreg(self.class_of(ty));
6702        self.sized(reg, ty);
6703        self.regs[value.index()] = Some(reg);
6704        let source = self.source;
6705        for decl in source.value_decls(value) {
6706            self.out.named.push((decl, reg));
6707        }
6708        reg
6709    }
6710
6711    /// Says how much of its register a value of that type takes, when the register is a vector
6712    /// one, which is what lets a call that keeps only the bottom of one keep the value in it.
6713    fn sized(&mut self, reg: mir::Reg, ty: Type) {
6714        if crate::term::in_vector_file(ty) {
6715            self.out.set_width(reg, abi::float_bytes(ty));
6716        }
6717    }
6718
6719    fn unsupported(&self, inst: Inst) -> Unsupported {
6720        let data = &self.source[inst];
6721        Unsupported::Inst {
6722            inst,
6723            term: Terms::new(self.source, inst, PLAIN).name(inst),
6724            opcode: data.opcode,
6725            ty: data.first_result.map(|result| self.source[result].ty),
6726        }
6727    }
6728}
6729
6730/// What the arguments of one replacement came to.
6731#[derive(Debug, Default)]
6732struct Read {
6733    regs: Vec<mir::Reg>,
6734    imm: Option<i64>,
6735    mem: Option<mir::Mem>,
6736}
6737
6738/// The addressing mode an address constructor's arguments make.
6739///
6740/// One arm per constructor rather than a question asked of the kind, because what the arguments
6741/// mean is the whole of what tells the four apart: the same register is a base in one and an
6742/// index in another, and the same constant is a scale in one and a displacement in another.
6743fn address(kind: Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
6744    let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
6745    match kind {
6746        Address::BaseIndexScale => {
6747            let base = regs.next()?;
6748            let index = regs.next()?;
6749            Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
6750        }
6751        Address::IndexScale => Some(mir::Mem {
6752            base: None,
6753            index: Some(regs.next()?),
6754            scale: u8::try_from(read.imm?).ok()?,
6755            disp: 0,
6756            symbol: None,
6757            block: None,
6758            table: None,
6759            reach: mir::Reach::Itself,
6760            segment: None,
6761        }),
6762        Address::Base => Some(mir::Mem::at(regs.next()?)),
6763        // The rule that writes this has a guard saying the constant fits, so a displacement that
6764        // does not is a rule and a target that disagree rather than a program this cannot compile.
6765        Address::BaseOffset => {
6766            Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
6767        }
6768    }
6769}
6770
6771#[cfg(test)]
6772mod tests {
6773    use rucc_ir::{
6774        AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
6775    };
6776    use rucc_regalloc::assign::Env;
6777    use rucc_target::x86_64::{FRAME, REGS, SYSV};
6778
6779    use super::*;
6780    use crate::finish::{Convention, finish};
6781    use crate::frame::{Frame, Incoming, Layout};
6782    use crate::select::x86_64::SELECTOR;
6783
6784    /// A function of as many 64 bit parameters as the test wants, and the block they are in.
6785    fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6786        let mut names = Interner::new();
6787        let mut func = Func::new(names.intern("f"), Signature::new());
6788        let block = func.create_block();
6789        let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
6790        (names, func, block, values)
6791    }
6792
6793    /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
6794    /// Neither field reaches selection, which is the point of saying it once here.
6795    fn plain() -> MemInfo {
6796        MemInfo {
6797            size: 0,
6798            align: 1,
6799            order: MemOrder::NotAtomic,
6800            tbaa: None,
6801            owns: 0,
6802            restrict: Restrict::NONE,
6803        }
6804    }
6805
6806    /// What the allocator is given: every integer register the convention offers except two, held
6807    /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
6808    /// somewhere to be read into. Which two does not matter, and holding back the last two the
6809    /// convention would reach for leaves every expectation below unchanged.
6810    fn env() -> Env {
6811        const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
6812        let order: Vec<PhysReg> =
6813            SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
6814        Env::new().with(x86_64::GPR, &order, &SCRATCH)
6815    }
6816
6817    /// The machine IR text a function lowers to.
6818    fn lower(names: &mut Interner, source: &Func) -> String {
6819        let out = func(source, names, &SELECTOR, &SYSV, &Elsewhere::default())
6820            .expect("every instruction has a rule");
6821        mir::print_func(&out.func, names, &REGS)
6822    }
6823
6824    /// The same function lowered for AArch64, which is the first thing this file writes for a
6825    /// machine other than x86-64. Nothing past selection runs here, so what is checked is that the
6826    /// arguments, the rule and the return all come out named for the machine that was asked for.
6827    #[test]
6828    fn an_addition_lowers_for_aarch64_with_its_own_names() {
6829        let i32 = Type::int(32);
6830        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6831        let mut build = Builder::new(&mut func, block);
6832        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
6833        build.ret(&[sum]);
6834
6835        let conv = &aarch64::AAPCS64;
6836        let selector = &crate::select::aarch64::SELECTOR;
6837        let out = super::func(&func, &mut names, selector, conv, &Elsewhere::default())
6838            .expect("an addition and a return have AArch64 rules");
6839        let text = mir::print_func(&out.func, &names, &aarch64::REGS);
6840        assert!(!text.contains("x64."), "{text}");
6841        assert!(text.contains("= a64.arg_val_32"), "{text}");
6842        assert!(text.contains("= a64.add_rr_32 %0, %1"), "{text}");
6843        assert!(text.contains("a64.ret_val_32 %2"), "{text}");
6844    }
6845
6846    /// Lowers one function for AArch64 and prints it, or says why it could not.
6847    fn lower_a64(names: &mut Interner, func: &Func) -> Result<String, String> {
6848        let conv = &aarch64::AAPCS64;
6849        let selector = &crate::select::aarch64::SELECTOR;
6850        let out = super::func(func, names, selector, conv, &Elsewhere::default())
6851            .map_err(|why| why.to_string())?;
6852        Ok(mir::print_func(&out.func, names, &aarch64::REGS))
6853    }
6854
6855    /// Nothing reads AArch64 assembly back into instructions, so every template there is kept as
6856    /// its text. The operands are the instruction's own, with the output first and the inputs
6857    /// last, a hole in the text asks for the `w` or the `x` name of one, and a vector register the
6858    /// clobber list names is written by it as well as every register a call may leave anything in.
6859    #[test]
6860    fn a_template_on_aarch64_is_kept_as_text_with_its_operands_in_registers() {
6861        let (i32, i64) = (Type::int(32), Type::int(64));
6862        let (mut names, mut source, block, args) = blank(&[i32, i64]);
6863        let out = clobbering(
6864            &mut source,
6865            block,
6866            &mut names,
6867            "add %w0, %w1, #1\n\tstr %2, [sp]",
6868            "=r,r,r",
6869            "d8",
6870            &[args[0], args[1]],
6871            &[i32],
6872        );
6873        let produced = source[out].results().next().expect("one result");
6874        Builder::new(&mut source, block).ret(&[produced]);
6875
6876        // Forty one registers between the output and the inputs: `x0` to `x15`, the sixteen vector
6877        // registers a call does not keep, and `v8`, which is the one the program named.
6878        let text = lower_a64(&mut names, &source).expect("kept as text");
6879        assert!(text.contains("%2:gpr, early $x0, early $x1,"), "{text}");
6880        assert!(text.contains(
6881            "early $v31, early $v8 = a64.template %0, %1, \
6882             @add \u{1}r0w\u{2}, \u{1}r42w\u{2}, #1\n\tstr \u{1}r43x\u{2}, [sp]\n"
6883        ));
6884    }
6885
6886    /// A letter that means one thing on x86 and another on AArch64 is refused there rather than
6887    /// read as x86. `a` to `d` and `S` name one register each on x86 and nothing on AArch64.
6888    #[test]
6889    fn a_constraint_letter_the_two_machines_disagree_about_is_refused_on_aarch64() {
6890        let i64 = Type::int(64);
6891        for constraints in ["=a,r", "=r,S", "=r,c"] {
6892            let (mut names, mut source, block, args) = blank(&[i64]);
6893            let out = clobbering(
6894                &mut source,
6895                block,
6896                &mut names,
6897                "mov %0, %1",
6898                constraints,
6899                "",
6900                &[args[0]],
6901                &[i64],
6902            );
6903            let produced = source[out].results().next().expect("one result");
6904            Builder::new(&mut source, block).ret(&[produced]);
6905            let refused = lower_a64(&mut names, &source).expect_err(constraints);
6906            assert!(refused.contains("has an operand this cannot place"), "{refused}");
6907        }
6908    }
6909
6910    /// `Q` on AArch64 is memory addressed by one register, which is `[x3]` and is how an operand in
6911    /// memory is spelled there already.
6912    #[test]
6913    fn a_q_operand_on_aarch64_is_its_address_in_brackets() {
6914        let (i64, ptr) = (Type::int(64), Type::PTR);
6915        let (mut names, mut source, block, args) = blank(&[ptr]);
6916        let out =
6917            clobbering(&mut source, block, &mut names, "ldr %x0, %1", "=r,Q", "", &args, &[i64]);
6918        let produced = source[out].results().next().expect("one result");
6919        Builder::new(&mut source, block).ret(&[produced]);
6920        let text = lower_a64(&mut names, &source).expect("kept as text");
6921        assert!(text.contains("@ldr \u{1}r0x\u{2}, [\u{1}r"), "{text}");
6922    }
6923
6924    /// `w` on AArch64 is a vector register, named `v` with no modifier the way gcc names it and by
6925    /// its scalar view with one. An integer asked for in one is refused, since it would need a move
6926    /// into that file first.
6927    #[test]
6928    fn a_vector_operand_on_aarch64_is_in_the_vector_file() {
6929        let f64 = Type::float(rucc_ir::Float::F64);
6930        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6931        let out = clobbering(
6932            &mut source,
6933            block,
6934            &mut names,
6935            "fadd %d0, %d1, %d2\n\tmov %0.16b, %0.16b",
6936            "=w,w,w",
6937            "",
6938            &[args[0], args[1]],
6939            &[f64],
6940        );
6941        let produced = source[out].results().next().expect("one result");
6942        Builder::new(&mut source, block).ret(&[produced]);
6943        let text = lower_a64(&mut names, &source).expect("kept as text");
6944        assert!(text.contains("%2:fpr, early $x0,"), "{text}");
6945        assert!(text.contains("@fadd \u{1}r0d\u{2}, \u{1}r"), "{text}");
6946        assert!(text.contains("\n\tmov \u{1}r0v\u{2}.16b, \u{1}r0v\u{2}.16b\n"), "{text}");
6947
6948        let i64 = Type::int(64);
6949        let (mut names, mut source, block, args) = blank(&[i64]);
6950        let out =
6951            clobbering(&mut source, block, &mut names, "fmov %d0, %d1", "=w,w", "", &args, &[i64]);
6952        let produced = source[out].results().next().expect("one result");
6953        Builder::new(&mut source, block).ret(&[produced]);
6954        assert!(lower_a64(&mut names, &source).is_err());
6955    }
6956
6957    #[test]
6958    fn an_addition_of_two_registers_is_one_instruction() {
6959        let i32 = Type::int(32);
6960        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6961        let mut build = Builder::new(&mut func, block);
6962        build.binary(Opcode::Add, args[0], args[1], Flags::default());
6963
6964        assert_eq!(
6965            lower(&mut names, &func),
6966            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6967             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
6968        );
6969    }
6970
6971    #[test]
6972    fn a_constant_operand_becomes_an_immediate() {
6973        let i32 = Type::int(32);
6974        let (mut names, mut func, block, args) = blank(&[i32]);
6975        let mut build = Builder::new(&mut func, block);
6976        let seven = build.iconst(i32, 7);
6977        build.binary(Opcode::Add, args[0], seven, Flags::default());
6978
6979        // The constant is in the instruction and nothing was written to hold it, which is what
6980        // materializing one where a register for it is wanted buys.
6981        assert_eq!(
6982            lower(&mut names, &func),
6983            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6984             %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
6985        );
6986    }
6987
6988    #[test]
6989    fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
6990        let i64 = Type::int(64);
6991        let (mut names, mut func, block, args) = blank(&[i64]);
6992        let mut build = Builder::new(&mut func, block);
6993        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
6994        build.binary(Opcode::Add, args[0], big, Flags::default());
6995
6996        // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
6997        // turns a number this wide down, so it does not fire, and the next way of showing the
6998        // operand puts it in a register.
6999        assert_eq!(
7000            lower(&mut names, &func),
7001            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7002             %1:gpr = x64.mov_ri_64 2147483648\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
7003        );
7004    }
7005
7006    #[test]
7007    fn an_index_calculation_folds_into_an_address() {
7008        let i64 = Type::int(64);
7009        let (mut names, mut func, block, args) = blank(&[i64, i64]);
7010        let mut build = Builder::new(&mut func, block);
7011        let four = build.iconst(i64, 4);
7012        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7013        build.binary(Opcode::Add, args[0], scaled, Flags::default());
7014
7015        // Three IR instructions and one machine instruction. The multiply is gone because the
7016        // rule that matched reached down and took it.
7017        assert_eq!(
7018            lower(&mut names, &func),
7019            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7020             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
7021        );
7022    }
7023
7024    #[test]
7025    fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
7026        let i64 = Type::int(64);
7027        let (mut names, mut func, block, args) = blank(&[i64, i64]);
7028        let mut build = Builder::new(&mut func, block);
7029        let four = build.iconst(i64, 4);
7030        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7031        let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
7032        build.binary(Opcode::Add, first, scaled, Flags::default());
7033
7034        // Both readers have room for a scaled index, so both of them take it and nothing is left
7035        // to read the multiply. Three IR instructions become two machine ones, where refusing to
7036        // fold into either reader would have left three.
7037        assert_eq!(
7038            lower(&mut names, &func),
7039            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7040             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n    \
7041             %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
7042        );
7043    }
7044
7045    #[test]
7046    fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
7047        let i64 = Type::int(64);
7048        let (mut names, mut func, block, args) = blank(&[i64, i64]);
7049        let mut build = Builder::new(&mut func, block);
7050        let four = build.iconst(i64, 4);
7051        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
7052        build.binary(Opcode::Add, args[0], scaled, Flags::default());
7053        build.store(scaled, args[0], plain(), Flags::default());
7054
7055        // The addition has room for the multiply and the store does not: what a store writes is
7056        // a register, and no rule reaches through it. Folding into the addition alone would
7057        // leave the multiply where it is for the store to read and do the work twice, so the
7058        // multiply is put back and both readers read the register it wrote.
7059        let text = lower(&mut names, &func);
7060        assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
7061        assert!(text.contains("x64.add_rr_64"), "{text}");
7062    }
7063
7064    #[test]
7065    fn a_shift_by_a_register_asks_for_it_in_cl() {
7066        let i32 = Type::int(32);
7067        let (mut names, mut func, block, args) = blank(&[i32, i32]);
7068        let mut build = Builder::new(&mut func, block);
7069        build.binary(Opcode::Shl, args[0], args[1], Flags::default());
7070
7071        // The fixed register is not in the rule. It is what the target says the instruction does
7072        // with its operands, and the allocator is what will act on it.
7073        let text = lower(&mut names, &func);
7074        assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
7075    }
7076
7077    #[test]
7078    fn a_division_names_the_registers_and_the_register_it_destroys() {
7079        let i32 = Type::int(32);
7080        let (mut names, mut func, block, args) = blank(&[i32, i32]);
7081        let mut build = Builder::new(&mut func, block);
7082        build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
7083
7084        // Two definitions, because a division writes the remainder whether anybody wanted it or
7085        // not, and the second one is early because it is destroyed before the operands are read.
7086        let text = lower(&mut names, &func);
7087        assert!(
7088            text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
7089            "{text}"
7090        );
7091    }
7092
7093    #[test]
7094    fn a_load_reads_through_the_register_the_address_is_in() {
7095        let i64 = Type::int(64);
7096        let (mut names, mut func, block, args) = blank(&[i64]);
7097        let mut build = Builder::new(&mut func, block);
7098        build.load(Type::int(32), args[0], plain(), Flags::default());
7099
7100        assert_eq!(
7101            lower(&mut names, &func),
7102            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7103             %1:gpr = x64.mov_rm_32 [%0]\n}\n"
7104        );
7105    }
7106
7107    #[test]
7108    fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
7109        let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
7110        let mut build = Builder::new(&mut func, block);
7111        build.store(args[0], args[1], plain(), Flags::default());
7112
7113        // The value is the first parameter and the address is the second, and the instruction
7114        // takes them the other way round. Getting that backwards would compile to a store of the
7115        // address into the value, which is a program that runs and does the wrong thing.
7116        assert_eq!(
7117            lower(&mut names, &func),
7118            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7119             %1:gpr($rsi) = x64.arg_val_64\n    x64.mov_mr_32 %0, [%1]\n}\n"
7120        );
7121    }
7122
7123    #[test]
7124    fn an_address_with_a_constant_added_folds_into_the_access() {
7125        let i64 = Type::int(64);
7126        let (mut names, mut func, block, args) = blank(&[i64]);
7127        let mut build = Builder::new(&mut func, block);
7128        let twelve = build.iconst(i64, 12);
7129        let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
7130        build.load(Type::int(64), field, plain(), Flags::default());
7131
7132        // Two IR instructions and one machine instruction, which is what every read of a field
7133        // of a structure comes to.
7134        assert_eq!(
7135            lower(&mut names, &func),
7136            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7137             %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
7138        );
7139    }
7140
7141    #[test]
7142    fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
7143        let i64 = Type::int(64);
7144        let (mut names, mut func, block, args) = blank(&[i64]);
7145        let mut build = Builder::new(&mut func, block);
7146        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
7147        let far = build.binary(Opcode::Add, args[0], big, Flags::default());
7148        build.load(Type::int(32), far, plain(), Flags::default());
7149
7150        // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
7151        // this down, so the addition stays and the load reads through what it produced. Nobody
7152        // wrote that fallback: it is the next way of showing the operand.
7153        let text = lower(&mut names, &func);
7154        assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
7155        assert!(text.contains("x64.add_rr_64"), "{text}");
7156    }
7157
7158    #[test]
7159    fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
7160        let i64 = Type::int(64);
7161        let (mut names, mut func, block, args) = blank(&[i64, i64]);
7162        let mut build = Builder::new(&mut func, block);
7163        let got = build.load(Type::int(8), args[0], plain(), Flags::default());
7164        build.store(got, args[1], plain(), Flags::default());
7165
7166        // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
7167        // most one memory operand, and there is no rule that takes two, so the load is left where
7168        // it is and the store reads the register it wrote.
7169        assert_eq!(
7170            lower(&mut names, &func),
7171            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7172             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.mov_rm_8 [%0]\n    \
7173             x64.mov_mr_8 %2, [%1]\n}\n"
7174        );
7175    }
7176
7177    #[test]
7178    fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
7179        let i64 = Type::int(64);
7180        let (mut names, mut source, block, args) = blank(&[i64]);
7181        let mut build = Builder::new(&mut source, block);
7182        build.load(Type::int(128), args[0], plain(), Flags::default());
7183
7184        // The width is the whole of what is wrong here, so the width is in the message: `load`
7185        // on its own is written about at every other width and would send a reader looking in
7186        // the wrong place.
7187        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7188            .expect_err("nothing loads 128 bits");
7189        assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
7190    }
7191
7192    #[test]
7193    fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
7194        let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
7195        let mut build = Builder::new(&mut func, block);
7196        build.ret(&[args[0]]);
7197
7198        // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
7199        // is what the target says the instruction does with its operand, and the allocator is
7200        // what will act on it. There is no `ret` here, because giving the frame back has to
7201        // happen between this and leaving and the frame is not worked out yet.
7202        assert_eq!(
7203            lower(&mut names, &func),
7204            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7205             x64.ret_val_32 %0($rax)\n}\n"
7206        );
7207    }
7208
7209    #[test]
7210    fn a_return_of_two_values_asks_for_the_second_register_as_well() {
7211        let i64 = Type::int(64);
7212        let (mut names, mut func, block, args) = blank(&[i64, i64]);
7213        let mut build = Builder::new(&mut func, block);
7214        build.ret(&[args[0], args[1]]);
7215
7216        // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
7217        // halves are integers, so the second is in the second integer return register, and both
7218        // pseudos say so the same way the one for a single value does.
7219        assert_eq!(
7220            lower(&mut names, &func),
7221            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7222             %1:gpr($rsi) = x64.arg_val_64\n    x64.ret_val_64 %0($rax)\n    \
7223             x64.ret_val2_64 %1($rdx)\n}\n"
7224        );
7225    }
7226
7227    #[test]
7228    fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
7229        let f64 = Type::float(rucc_ir::Float::F64);
7230        let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
7231        let mut build = Builder::new(&mut func, block);
7232        build.ret(&[args[0], args[1]]);
7233
7234        // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
7235        // neither half is the second of anything and the `double` is in `xmm0` rather than in the
7236        // register a second `double` would have been in. Getting this wrong is not a crash: the
7237        // caller reads a register nobody wrote, and this is where that is ruled out.
7238        assert_eq!(
7239            lower(&mut names, &func),
7240            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
7241             %1:gpr($rdi) = x64.arg_val_64\n    x64.ret_val_f64 %0($xmm0)\n    \
7242             x64.ret_val_64 %1($rax)\n}\n"
7243        );
7244    }
7245
7246    #[test]
7247    fn two_of_the_same_file_back_take_the_first_two_of_it() {
7248        let f64 = Type::float(rucc_ir::Float::F64);
7249        let (mut names, mut func, block, args) = blank(&[f64, f64]);
7250        let mut build = Builder::new(&mut func, block);
7251        build.ret(&[args[0], args[1]]);
7252
7253        // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
7254        // above and counts in its own file the same way.
7255        assert_eq!(
7256            lower(&mut names, &func),
7257            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
7258             %1:xmm($xmm1) = x64.arg_val_f64\n    x64.ret_val_f64 %0($xmm0)\n    \
7259             x64.ret_val2_f64 %1($xmm1)\n}\n"
7260        );
7261    }
7262
7263    /// A function whose answer goes back through memory, with the pointer to the space for it in
7264    /// front of whatever else it takes. Only the signature says it is one.
7265    fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
7266        let mut names = Interner::new();
7267        let sret = Abi::Sret { size: 32, align: 8 };
7268        let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
7269        signature.params.extend(params.iter().copied().map(Param::new));
7270        let mut func = Func::new(names.intern("f"), signature);
7271        let block = func.create_block();
7272        let space = func.append_param(block, Type::PTR);
7273        let values = std::iter::once(space)
7274            .chain(params.iter().map(|&ty| func.append_param(block, ty)))
7275            .collect();
7276        (names, func, block, values)
7277    }
7278
7279    #[test]
7280    fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
7281        let (mut names, mut func, block, _) = returning_through_memory(&[]);
7282        Builder::new(&mut func, block).ret(&[]);
7283
7284        // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
7285        // carries nothing, because the value went into the space the caller handed over, and the
7286        // document still says that address comes back in `rax`. Nothing in the IR says it, so the
7287        // convention says it, and the pseudo is the one any other pointer return would use.
7288        assert_eq!(
7289            lower(&mut names, &func),
7290            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7291             x64.ret_val_64 %0($rax)\n}\n"
7292        );
7293    }
7294
7295    #[test]
7296    fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
7297        let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
7298        let mut build = Builder::new(&mut func, block);
7299        build.store(args[1], args[0], plain(), Flags::default());
7300        build.ret(&[]);
7301
7302        // The register is a read at the end and not a move at the start, so it is live across
7303        // everything between the two and the allocator has to keep it somewhere. In a function
7304        // with a call in it that somewhere is a callee saved register, and the address comes back
7305        // into `rax` here rather than whatever the last instruction happened to leave there. That
7306        // is issue #333, and a store is enough to show the value outlives the entry block.
7307        let text = lower(&mut names, &func);
7308        assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
7309        assert!(text.ends_with("    x64.ret_val_64 %0($rax)\n}\n"), "{text}");
7310    }
7311
7312    #[test]
7313    fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
7314        let (mut names, mut func, block, args) = blank(&[Type::PTR]);
7315        let mut build = Builder::new(&mut func, block);
7316        build.store(args[0], args[0], plain(), Flags::default());
7317        build.ret(&[]);
7318
7319        // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
7320        // the one above and none of its meaning, and what tells them apart is the signature. A
7321        // `void` function leaves `rax` alone.
7322        assert!(!lower(&mut names, &func).contains("ret_val"));
7323    }
7324
7325    #[test]
7326    fn a_return_of_a_constant_puts_it_in_a_register_first() {
7327        let (mut names, mut func, block, _) = blank(&[]);
7328        let mut build = Builder::new(&mut func, block);
7329        let zero = build.iconst(Type::int(32), 0);
7330        build.ret(&[zero]);
7331
7332        // No rule returns an immediate, so the plan that offers one is turned down and the next
7333        // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
7334        // is appended to it.
7335        assert_eq!(
7336            lower(&mut names, &func),
7337            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
7338        );
7339    }
7340
7341    #[test]
7342    fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
7343        let (mut names, mut func, block, _) = blank(&[]);
7344        let mut build = Builder::new(&mut func, block);
7345        let zero = build.iconst(Type::int(32), 0);
7346        build.ret(&[zero]);
7347
7348        // The loop over the instructions passes a constant by, because a constant is written where
7349        // a register for it is first wanted rather than where the IR put it. So the only place a
7350        // rule about one is ever selected is the materialization, and a mark made in the loop
7351        // alone would report every rule about a constant as a rule nothing reaches.
7352        let out = super::func(&func, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7353            .expect("every instruction has a rule");
7354        let rules = &crate::select::x86_64::TABLE.rules;
7355        let fired: Vec<&str> = rules
7356            .iter()
7357            .enumerate()
7358            .filter(|(index, _)| out.fired.has(*index))
7359            .map(|(_, rule)| rule.pattern)
7360            .collect();
7361        assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
7362    }
7363
7364    #[test]
7365    fn a_return_of_nothing_is_no_instruction_at_all() {
7366        let (mut names, mut func, block, _) = blank(&[]);
7367        let mut build = Builder::new(&mut func, block);
7368        build.ret(&[]);
7369
7370        // Every part of leaving a function that returns nothing is the epilogue's, and the
7371        // epilogue goes in after allocation. A block with nothing in it is the right answer here
7372        // rather than a function that could not be lowered.
7373        assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
7374    }
7375
7376    #[test]
7377    fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
7378        let (mut names, mut source, block, _) = blank(&[]);
7379        let mut build = Builder::new(&mut source, block);
7380        let zero = build.iconst(Type::int(32), 0);
7381        build.ret(&[zero]);
7382
7383        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7384            .expect("every instruction has a rule")
7385            .func;
7386        let env = env();
7387        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7388        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7389        finish(
7390            &mut out,
7391            &allocation,
7392            &frame,
7393            &Stack::default(),
7394            Convention::new(&SYSV, &FRAME),
7395            &mut names,
7396        );
7397
7398        // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
7399        // the value goes back, the target said where, and the allocator is what made it true. The
7400        // epilogue is what leaves, and this function needs no frame, so it is the return alone.
7401        //
7402        // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
7403        // so `rax` is the register the allocator tries first for the value the return reads, and
7404        // the constant is written straight into it.
7405        assert_eq!(
7406            mir::print_func(&out, &names, &REGS),
7407            "mfunc @f {\nblock0:\n    $rax = x64.mov_ri_32 0\n    \
7408             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
7409        );
7410    }
7411
7412    #[test]
7413    fn a_function_of_two_arguments_is_a_whole_function_now() {
7414        let i32 = Type::int(32);
7415        let (mut names, mut source, block, args) = blank(&[i32, i32]);
7416        let mut build = Builder::new(&mut source, block);
7417        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7418        build.ret(&[sum]);
7419
7420        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7421            .expect("every instruction has a rule")
7422            .func;
7423        let env = env();
7424        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7425        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7426        finish(
7427            &mut out,
7428            &allocation,
7429            &frame,
7430            &Stack::default(),
7431            Convention::new(&SYSV, &FRAME),
7432            &mut names,
7433        );
7434
7435        // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
7436        // side exists for. Before it there was no way to write one: the allocator refuses a
7437        // function whose entry block takes parameters, because there is no edge into an entry
7438        // block for the moves that give a block parameter its value to go on.
7439        //
7440        // One move, and it is the one the machine's addition needs rather than one the allocator
7441        // owes anybody. Each argument stays in the register it arrived in, because the pseudo
7442        // that defines it insists on that register and the allocator now tries it first, and the
7443        // sum stays in the register the addition wrote it to until the return reads it out. The
7444        // copy in front of a two address instruction is what makes its destination one of the
7445        // registers it reads, and the source operand keeps its own name because the destination
7446        // is what the encoder writes.
7447        assert_eq!(
7448            mir::print_func(&out, &names, &REGS),
7449            "mfunc @f {\nblock0:\n    $rdi($rdi) = x64.arg_val_32\n    \
7450             $rsi($rsi) = x64.arg_val_32\n    \
7451             $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n    $rax = x64.mov_rr_64 $rdi\n    \
7452             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
7453        );
7454    }
7455
7456    #[test]
7457    fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
7458        let i64 = Type::int(64);
7459        let (mut names, mut source, block, args) = blank(&[i64; 7]);
7460        let mut build = Builder::new(&mut source, block);
7461        build.ret(&[args[6]]);
7462
7463        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7464            .expect("the seventh is read from memory");
7465
7466        // SysV passes six integers in registers and the seventh in the caller's memory, so six of
7467        // these are pseudos that encode to nothing and the seventh is a load that encodes to real
7468        // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
7469        // yet. What the walk hands on is which instruction is waiting, and for how far up the
7470        // caller's argument area, which is the bottom of it because it is the first one there.
7471        assert_eq!(lowered.stack.arguments.len(), 1);
7472        assert_eq!(lowered.stack.arguments[0].1, 0);
7473        let text = mir::print_func(&lowered.func, &names, &REGS);
7474        assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
7475        assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
7476    }
7477
7478    #[test]
7479    fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
7480        let i64 = Type::int(64);
7481        let (mut names, mut source, block, args) = blank(&[i64; 8]);
7482        let mut build = Builder::new(&mut source, block);
7483        let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
7484        build.ret(&[sum]);
7485
7486        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7487            .expect("both are read from memory");
7488        let stack = lowered.stack;
7489        let mut out = lowered.func;
7490        let env = env();
7491        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7492        let layout = stack.layout(Layout::new(&SYSV, REGS));
7493        let frame = Frame::of(&out, &allocation, &layout);
7494        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7495
7496        // A leaf that takes no frame, so the stack pointer never moves and the only thing between
7497        // it and the caller's arguments is the return address the call pushed. The seventh
7498        // parameter is at the bottom of the caller's argument area and the eighth is one word
7499        // further up, which is the eight bytes between the two offsets.
7500        let text = mir::print_func(&out, &names, &REGS);
7501        assert_eq!(frame.size(), 0);
7502        assert_eq!(frame.incoming(), Incoming::from_stack(8));
7503        assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
7504        assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
7505    }
7506
7507    #[test]
7508    fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
7509        let i64 = Type::int(64);
7510        let (mut names, mut source, block, args) = blank(&[i64; 7]);
7511        let wide = slot(&mut source, block, 64, 32);
7512        let mut build = Builder::new(&mut source, block);
7513        build.store(args[6], wide, plain(), Flags::default());
7514        build.ret(&[args[6]]);
7515
7516        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7517            .expect("every instruction has a rule");
7518        let stack = lowered.stack;
7519        let mut out = lowered.func;
7520        let env = env();
7521        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7522        let layout = stack.layout(Layout::new(&SYSV, REGS));
7523        let frame = Frame::of(&out, &allocation, &layout);
7524        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7525
7526        // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
7527        // which throws away how far the caller's stack was. So the load the lowering wrote off the
7528        // stack pointer is rewritten to read through the frame pointer, at the one distance that
7529        // survives: the word the prologue pushed the frame pointer into, and the return address
7530        // above it.
7531        let text = mir::print_func(&out, &names, &REGS);
7532        assert_eq!(frame.realign(), Some(32));
7533        assert_eq!(frame.incoming(), Incoming::from_frame(16));
7534        assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
7535        assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
7536    }
7537
7538    #[test]
7539    fn a_jump_is_the_edge_and_nothing_else() {
7540        let i32 = Type::int(32);
7541        let (mut names, mut source, entry, args) = blank(&[i32]);
7542        let next = source.create_block();
7543        let got = source.append_param(next, i32);
7544        Builder::new(&mut source, entry).jump(next, &[args[0]]);
7545        Builder::new(&mut source, next).ret(&[got]);
7546
7547        // Two blocks and two instructions, and the jump is neither of them. What it was is the
7548        // arm on the first block, and what the arm carries is the argument it was called with.
7549        assert_eq!(
7550            lower(&mut names, &source),
7551            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
7552             block1(%1:gpr):\n    x64.ret_val_32 %1($rax)\n}\n"
7553        );
7554    }
7555
7556    /// A block that reads what a block below it writes is filled after it, not before it.
7557    ///
7558    /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
7559    /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
7560    /// Filling them in the order they are written reaches the read in `early` first, and reading
7561    /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
7562    /// what it does is give its answer the register its operand is already in, and that is not
7563    /// the register the read minted. Nothing writes the register the read minted. The printer
7564    /// says `%?` for a register nothing defines, which is what this looks for, and what came out
7565    /// of the real bug was SQLite loading a stack slot no store ever reached.
7566    #[test]
7567    fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
7568        let i64 = Type::int(64);
7569        let (mut names, mut source, entry, args) = blank(&[i64, i64]);
7570        let early = source.create_block();
7571        let late = source.create_block();
7572        let exit = source.create_block();
7573
7574        Builder::new(&mut source, entry).jump(late, &[]);
7575        let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
7576        Builder::new(&mut source, early).ret(&[ptr]);
7577        let mut build = Builder::new(&mut source, late);
7578        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7579        build.br_if(cond, early, &[], exit, &[]);
7580        Builder::new(&mut source, exit).ret(&[args[1]]);
7581
7582        let text = lower(&mut names, &source);
7583        assert!(!text.contains("%?"), "every register has something that writes it: {text}");
7584    }
7585
7586    /// A constant is written where it is wanted rather than where the IR defined it, and two
7587    /// blocks wanting the same one is two places. Writing it once and reading it in both is a
7588    /// register read where nothing wrote it, unless the block it was written in happens to
7589    /// dominate the other, which nothing here checks and which the second arm of a branch never
7590    /// does. Each block gets its own copy of the number instead.
7591    #[test]
7592    fn a_constant_two_blocks_want_is_written_in_both_of_them() {
7593        let i32 = Type::int(32);
7594        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7595        let then = source.create_block();
7596        let other = source.create_block();
7597        let join = source.create_block();
7598        let got = source.append_param(join, i32);
7599
7600        let mut build = Builder::new(&mut source, entry);
7601        let seven = build.iconst(i32, 7);
7602        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7603        build.br_if(cond, then, &[], other, &[]);
7604        // Both arms want the seven in a register, because a block argument is never an immediate,
7605        // and neither arm dominates the other.
7606        Builder::new(&mut source, then).jump(join, &[seven]);
7607        Builder::new(&mut source, other).jump(join, &[seven]);
7608        Builder::new(&mut source, join).ret(&[got]);
7609
7610        let text = lower(&mut names, &source);
7611        assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
7612    }
7613
7614    /// An argument on an edge out of a block that leaves two ways is read after every instruction
7615    /// of the block is written, and reading one can write an instruction, which would land after
7616    /// the branch that has already jumped past it. The branch goes back on the end.
7617    #[test]
7618    fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
7619        let i32 = Type::int(32);
7620        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7621        let then = source.create_block();
7622        let join = source.create_block();
7623        let got = source.append_param(join, i32);
7624
7625        let mut build = Builder::new(&mut source, entry);
7626        let nine = build.iconst(i32, 9);
7627        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7628        build.br_if(cond, then, &[], join, &[nine]);
7629        Builder::new(&mut source, then).jump(join, &[args[0]]);
7630        Builder::new(&mut source, join).ret(&[got]);
7631
7632        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7633            .expect("every instruction has a rule")
7634            .func;
7635        let entry = out.entry().expect("an entry block");
7636        let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
7637        let branch = names.intern("x64.br_cond_8");
7638        assert_eq!(
7639            out[last].opcode,
7640            mir::Opcode::new(branch),
7641            "the branch is last: {}",
7642            mir::print_func(&out, &names, &REGS)
7643        );
7644    }
7645
7646    #[test]
7647    fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
7648        let i32 = Type::int(32);
7649        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7650        let then = source.create_block();
7651        let other = source.create_block();
7652        let mut build = Builder::new(&mut source, entry);
7653        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7654        build.br_if(cond, then, &[], other, &[]);
7655        Builder::new(&mut source, then).ret(&[args[0]]);
7656        Builder::new(&mut source, other).ret(&[args[1]]);
7657
7658        // The comparison writes a byte and the branch reads it, and neither says a block. Both
7659        // arms are on the entry block, in the order the branch took them, so the arm that runs
7660        // when the condition holds is the first.
7661        assert_eq!(
7662            lower(&mut names, &source),
7663            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7664             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
7665             x64.br_cond_8 %2, block1, block2\n\n\
7666             block1:\n    x64.ret_val_32 %0($rax)\n\n\
7667             block2:\n    x64.ret_val_32 %1($rax)\n}\n"
7668        );
7669    }
7670
7671    /// A choice between two values, which is one instruction and no blocks at all.
7672    ///
7673    /// The arms come out the other way round from the IR, because a conditional move overwrites its
7674    /// destination and the destination is the arm taken when the condition does not hold. The
7675    /// condition arrives last for the same reason: it is read by the test in front of the move
7676    /// rather than by the move.
7677    #[test]
7678    fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
7679        let i32 = Type::int(32);
7680        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7681        let mut build = Builder::new(&mut source, entry);
7682        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7683        let picked = build.select(cond, args[0], args[1]);
7684        build.ret(&[picked]);
7685
7686        assert_eq!(
7687            lower(&mut names, &source),
7688            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7689             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
7690             %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n    \
7691             x64.ret_val_32 %3($rax)\n}\n"
7692        );
7693    }
7694
7695    #[test]
7696    fn a_branch_over_a_block_is_a_whole_function_now() {
7697        let i32 = Type::int(32);
7698        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7699        let then = source.create_block();
7700        let other = source.create_block();
7701        let join = source.create_block();
7702        let got = source.append_param(join, i32);
7703        let mut build = Builder::new(&mut source, entry);
7704        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7705        build.br_if(cond, then, &[], other, &[]);
7706        let mut build = Builder::new(&mut source, then);
7707        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7708        build.jump(join, &[sum]);
7709        Builder::new(&mut source, other).jump(join, &[args[1]]);
7710        Builder::new(&mut source, join).ret(&[got]);
7711
7712        // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
7713        // the way a front end writes it: both arms of the branch are blocks of their own and the
7714        // return is the block they meet at. No edge here is critical, because the two arms out of
7715        // the entry carry nothing and the two arms into the join each leave a block that goes
7716        // nowhere else, so each has its own end to put its move at.
7717        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7718            .expect("every instruction has a rule")
7719            .func;
7720        assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
7721        let env = env();
7722        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7723        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7724        finish(
7725            &mut out,
7726            &allocation,
7727            &frame,
7728            &Stack::default(),
7729            Convention::new(&SYSV, &FRAME),
7730            &mut names,
7731        );
7732
7733        // One epilogue, on the join, which is the one block the function leaves from, and the
7734        // moves that give the join its parameter are at the end of each arm. Every register is
7735        // physical and the branch is still a branch on a register, because turning it into a
7736        // `test` and a `jcc` is the block layout's and there is no block layout yet.
7737        let text = mir::print_func(&out, &names, &REGS);
7738        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7739        assert!(text.contains("x64.br_cond_8"), "{text}");
7740        assert!(text.contains("x64.add_rr_32"), "{text}");
7741        assert!(!text.contains('%'), "{text}");
7742    }
7743
7744    #[test]
7745    fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
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 join = source.create_block();
7750        let got = source.append_param(join, i32);
7751        let mut build = Builder::new(&mut source, entry);
7752        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7753        build.br_if(cond, then, &[], join, &[args[1]]);
7754        Builder::new(&mut source, then).jump(join, &[args[0]]);
7755        let mut build = Builder::new(&mut source, join);
7756        let twice = build.binary(Opcode::Add, got, got, Flags::default());
7757        build.ret(&[twice]);
7758
7759        // The else arm is critical: the entry block leaves two ways and the join is arrived at
7760        // two ways, and the arm carries a value. Without splitting it the allocator asserts,
7761        // because the move that gives the join its parameter would have to run at the end of a
7762        // block that also goes to the other arm.
7763        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7764            .expect("every instruction has a rule")
7765            .func;
7766        assert_eq!(crate::split::critical(&mut out), 1);
7767        let env = env();
7768        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7769        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7770        finish(
7771            &mut out,
7772            &allocation,
7773            &frame,
7774            &Stack::default(),
7775            Convention::new(&SYSV, &FRAME),
7776            &mut names,
7777        );
7778
7779        // The block the split added is where the move went, and it is the whole of that block.
7780        let text = mir::print_func(&out, &names, &REGS);
7781        assert_eq!(out.block_count(), 4, "{text}");
7782        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7783    }
7784
7785    #[test]
7786    fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
7787        let i32 = Type::int(32);
7788        let (mut names, mut source, block, args) = blank(&[i32, i32]);
7789        let sig =
7790            source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
7791        let callee = names.intern("g");
7792        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
7793        let got = source[call].first_result.expect("an integer comes back");
7794        Builder::new(&mut source, block).ret(&[got]);
7795
7796        // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
7797        // them, so what the call reads is what arrived, and the whole of the convention is in the
7798        // constraints rather than in a move.
7799        let text = lower(&mut names, &source);
7800        assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
7801        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7802        // What the call writes is the value that comes back and then every register the callee is
7803        // free to destroy, in both classes, which is the whole of what stops the allocator from
7804        // leaving something in one of them.
7805        assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
7806        assert!(text.contains("$xmm15 = x64.call"), "{text}");
7807    }
7808
7809    #[test]
7810    fn what_the_frame_owes_a_call_comes_back_with_the_function() {
7811        let i32 = Type::int(32);
7812        let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
7813
7814        let (mut names, mut source, block, args) = blank(&[i32]);
7815        let sig = sig(&mut source);
7816        let callee = names.intern("g");
7817        Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7818        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7819            .expect("every instruction has a rule");
7820
7821        // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
7822        // owes the callee an aligned stack pointer and may not use the red zone.
7823        assert_eq!(out.stack.calls, Some(0));
7824        let layout = out.stack.layout(Layout::new(&SYSV, REGS));
7825        assert!(!layout.leaf);
7826        assert_eq!(layout.outgoing, 0);
7827
7828        // The same call under the other convention owes thirty two bytes for the callee to spill
7829        // its register arguments into, which is a fact about the convention and not about the call.
7830        let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7831            .expect("every instruction has a rule");
7832        assert_eq!(out.stack.calls, Some(32));
7833
7834        // And a function that calls nothing is a leaf, which is what says it may use the red zone.
7835        let (mut names, mut source, block, args) = blank(&[i32]);
7836        Builder::new(&mut source, block).ret(&[args[0]]);
7837        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7838            .expect("every instruction has a rule");
7839        assert_eq!(out.stack.calls, None);
7840        assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
7841    }
7842
7843    /// A Windows variadic prologue writes the argument registers the signature did not name into
7844    /// the shadow space the caller already reserved, which makes every argument one run of words up
7845    /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
7846    /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
7847    #[test]
7848    fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
7849        let mut names = Interner::new();
7850        let params = [Type::int(32), Type::PTR];
7851        let signature = Signature::new().with_params(&params).variadic();
7852        let mut source = Func::new(names.intern("f"), signature);
7853        let block = source.create_block();
7854        let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
7855        let mut build = Builder::new(&mut source, block);
7856        let args = build.func().push_values(&values[1..]);
7857        build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
7858        build.ret(&[]);
7859
7860        let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7861            .expect("every instruction has a rule");
7862        let text = mir::print_func(&out.func, &names, &REGS);
7863
7864        // Two named parameters, so the registers at the next two positions hold arguments nobody
7865        // named and both are written up into the caller's area. The displacement is empty here and
7866        // `finish` fills it in, the same way it does for a parameter the registers ran out before.
7867        assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
7868        assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
7869        assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
7870        assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
7871
7872        // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
7873        // sixteen bytes up, which is where the two arguments the signature does name stopped.
7874        assert_eq!(out.stack.arguments.len(), 3);
7875        assert_eq!(out.stack.arguments[2].1, 16);
7876    }
7877
7878    #[test]
7879    fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
7880        let i32 = Type::int(32);
7881        let (mut names, mut source, block, args) = blank(&[i32]);
7882        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7883        let callee = names.intern("g");
7884        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7885        let got = source[call].first_result.expect("an integer comes back");
7886        let mut build = Builder::new(&mut source, block);
7887        let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
7888        build.ret(&[sum]);
7889
7890        // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
7891        // question: `a` is read after the call and `rdi` is a register the call destroys.
7892        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7893            .expect("every instruction has a rule");
7894        let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
7895        let mut out = lowered.func;
7896        let env = env();
7897        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7898        let frame = Frame::of(&out, &allocation, &layout);
7899        finish(
7900            &mut out,
7901            &allocation,
7902            &frame,
7903            &Stack::default(),
7904            Convention::new(&SYSV, &FRAME),
7905            &mut names,
7906        );
7907
7908        // It went to a register the callee has to put back, and the prologue and epilogue are what
7909        // put it back, which is the whole bargain the two halves of a convention make.
7910        let text = mir::print_func(&out, &names, &REGS);
7911        assert!(text.contains("$rbx"), "{text}");
7912        assert!(!text.contains('%'), "{text}");
7913        assert_eq!(text.matches("x64.call").count(), 1, "{text}");
7914    }
7915
7916    #[test]
7917    fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
7918        let i64 = Type::int(64);
7919        let (mut names, mut source, block, args) = blank(&[i64]);
7920        let seven = vec![i64; 7];
7921        let sig = source.add_signature(Signature::new().with_params(&seven));
7922        let callee = names.intern("g");
7923        let passed = vec![args[0]; 7];
7924        Builder::new(&mut source, block).call(callee, sig, &passed);
7925
7926        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7927            .expect("the seventh goes to memory");
7928        // The bytes the call needs are on the layout the frame is worked out from, so that the
7929        // frame reserves as many as the widest call in the function asked for.
7930        assert_eq!(lowered.stack.calls, Some(8));
7931        let text = mir::print_func(&lowered.func, &names, &REGS);
7932        assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
7933    }
7934
7935    #[test]
7936    fn a_call_this_cannot_make_is_reported_rather_than_made() {
7937        let (mut names, mut source, block, _) = blank(&[]);
7938        let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
7939        let sig = source.add_signature(Signature::new().with_returns(&returns));
7940        let callee = names.intern("g");
7941        Builder::new(&mut source, block).call(callee, sig, &[]);
7942        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7943            .expect_err("a long double is on the x87");
7944        assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
7945    }
7946
7947    /// A `long double` on its own is a different answer, because on its own it comes back on the
7948    /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
7949    ///
7950    /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
7951    /// straight after it. That instruction has to be straight after it: the stack is one place and
7952    /// anything else that touched it before this ran would be looking at the value still on it.
7953    #[test]
7954    fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
7955        let (mut names, mut source, block, _) = blank(&[]);
7956        let long_double = Type::float(rucc_ir::Float::F80);
7957        let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
7958        let callee = names.intern("g");
7959        Builder::new(&mut source, block).call(callee, sig, &[]);
7960
7961        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7962            .expect("the value comes back in st0");
7963        let text = mir::print_func(&lowered.func, &names, &REGS);
7964        let after: Vec<&str> =
7965            text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
7966        assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
7967        assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
7968        // And the slot it went into is the sixteen bytes the type takes, like every other one.
7969        assert_eq!(lowered.stack.locals.len(), 1, "{text}");
7970        assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
7971    }
7972
7973    #[test]
7974    fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
7975        let i32 = Type::int(32);
7976        let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
7977        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7978        let varargs = source.push_abis(&[]);
7979        let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
7980        let mut build = Builder::new(&mut source, block);
7981        let inst = InstData {
7982            args: build.func().push_values(&[args[0], args[1]]),
7983            extra: Extra::Call(info),
7984            ..InstData::new(Opcode::CallIndirect)
7985        };
7986        let called = build.inst(inst, &[i32]);
7987        let got = source[called].first_result.expect("an integer comes back");
7988        Builder::new(&mut source, block).ret(&[got]);
7989
7990        // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
7991        // the arguments are the ones behind it, and everything else about the call is what a call
7992        // to a name would have been.
7993        let text = lower(&mut names, &source);
7994        assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
7995        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7996        assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
7997    }
7998
7999    #[test]
8000    fn an_instruction_no_rule_covers_is_reported() {
8001        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8002        let mut build = Builder::new(&mut source, block);
8003        let operands = build.func().push_values(&[args[0]]);
8004        build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
8005
8006        // The mark that an object has come into being, which nothing writes an instruction for
8007        // yet: what it needs is a write over a range of the lifetime plane, and that is
8008        // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
8009        // message to add beyond the name.
8010        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8011            .expect_err("no rule writes the beginning of a lifetime");
8012        assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
8013
8014        // It produces nothing, so there is no type in the message and nothing invents one, and the
8015        // instruction comes back so a caller can ask the function where it was.
8016        let inst = failed.inst().expect("the instruction it is about");
8017        assert_eq!(source[inst].opcode, Opcode::MetaBegin);
8018    }
8019
8020    /// A barrier is written by name here, and what it is depends on the ordering and on nothing
8021    /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
8022    #[test]
8023    fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
8024        for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
8025            let (mut names, mut source, block, _) = blank(&[]);
8026            let mut build = Builder::new(&mut source, block);
8027            build
8028                .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
8029
8030            let text = lower(&mut names, &source);
8031            assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
8032        }
8033    }
8034
8035    /// A compare and exchange is written by name too, and at the width of the value rather than at
8036    /// the width of the address, which is the mistake worth pinning: everything here is a pointer
8037    /// and only the value says how many bytes the instruction touches.
8038    #[test]
8039    fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
8040        for bits in [8, 16, 32, 64] {
8041            let ty = Type::int(bits);
8042            let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
8043            let mut build = Builder::new(&mut source, block);
8044            let mem = build.func().add_mem(MemInfo {
8045                size: u64::from(bits / 8),
8046                align: bits / 8,
8047                order: MemOrder::SeqCst,
8048                ..plain()
8049            });
8050            let operands = build.func().push_values(&[args[0], args[1], args[2]]);
8051            build.inst(
8052                InstData {
8053                    args: operands,
8054                    extra: Extra::Mem(mem),
8055                    ..InstData::new(Opcode::Cmpxchg)
8056                },
8057                &[ty, Type::I1],
8058            );
8059
8060            // Two values out of one instruction, the first of them in the register the machine
8061            // reads the expected value out of, the second free for the allocator to place. The
8062            // address is the memory operand and neither of the two values is.
8063            let text = lower(&mut names, &source);
8064            let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
8065            assert!(text.contains(&written), "{bits}: {text}");
8066        }
8067    }
8068
8069    #[test]
8070    fn more_values_back_than_the_convention_has_registers_for_is_reported() {
8071        let i64 = Type::int(64);
8072        let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
8073        let mut build = Builder::new(&mut source, block);
8074        build.ret(&[args[0], args[1], args[2]]);
8075
8076        // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
8077        // gap in the rules but the convention saying no. The front end classifies before it gets
8078        // here, so this is the shape that would mean the classification went wrong.
8079        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8080            .expect_err("only two come back");
8081        assert_eq!(
8082            failed.to_string(),
8083            "what this function gives back takes more registers than this convention has for it"
8084        );
8085
8086        let inst = failed.inst().expect("the instruction it is about");
8087        assert_eq!(source[inst].opcode, Opcode::Return);
8088    }
8089
8090    /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
8091    ///
8092    /// Everything else is about something written somewhere in the body and hands it back so a
8093    /// caller can ask the function where it came from. A parameter arrives before the first
8094    /// instruction runs, so there is nothing in the body to point at and the message is about
8095    /// the function.
8096    #[test]
8097    fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
8098        let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
8099        assert_eq!(missing.inst(), None);
8100    }
8101
8102    /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
8103    fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
8104        let info = MemInfo { size, align, ..plain() };
8105        let mut build = Builder::new(source, block);
8106        let mem = build.func().add_mem(info);
8107        build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
8108    }
8109
8110    #[test]
8111    fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
8112        let (mut names, mut source, block, _) = blank(&[]);
8113        let slot = slot(&mut source, block, 4, 4);
8114        let mut build = Builder::new(&mut source, block);
8115        let nine = build.iconst(Type::int(32), 9);
8116        build.store(nine, slot, plain(), Flags::default());
8117        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
8118        build.ret(&[loaded]);
8119
8120        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8121            .expect("every instruction has a rule");
8122
8123        // Four bytes on the list the frame is laid out from, and the one instruction that reads
8124        // where they went. Its displacement is nothing here because there is no frame yet, and
8125        // which instruction is waiting for which local is what `finish` is handed.
8126        assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
8127        assert_eq!(lowered.stack.addresses.len(), 1);
8128        assert_eq!(lowered.stack.addresses[0].1, 0);
8129        assert_eq!(
8130            mir::print_func(&lowered.func, &names, &REGS),
8131            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [$rsp]\n    \
8132             %1:gpr = x64.mov_ri_32 9\n    x64.mov_mr_32 %1, [%0]\n    \
8133             %2:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %2($rax)\n}\n"
8134        );
8135    }
8136
8137    #[test]
8138    fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
8139        let (mut names, mut source, block, _) = blank(&[]);
8140        let scratch = slot(&mut source, block, 4, 4);
8141        let mut build = Builder::new(&mut source, block);
8142        let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
8143        let declared = build
8144            .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
8145        build.func().declare_mem(mem, 41);
8146        build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
8147        build.ret(&[]);
8148
8149        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8150            .expect("every instruction has a rule");
8151
8152        // Two locals and one declaration, held against the order the allocas were lowered in,
8153        // which is the only name a local has by the time the frame places it. The scratch one was
8154        // reached first and is local zero, so the declared one is local one.
8155        assert_eq!(lowered.stack.locals.len(), 2);
8156        assert_eq!(lowered.stack.declared, vec![(1, 41)]);
8157    }
8158
8159    /// A local the program kept in a value comes out saying which register holds it.
8160    ///
8161    /// The other half of the local above, which had a slot. This one has none, so what carries the
8162    /// declaration is the register the instruction computing it writes into.
8163    #[test]
8164    fn a_local_the_program_kept_in_a_value_says_which_register_holds_it() {
8165        let (mut names, mut source, block, _) = blank(&[]);
8166        let mut build = Builder::new(&mut source, block);
8167        let nine = build.iconst(Type::int(32), 9);
8168        let ten = build.iconst(Type::int(32), 10);
8169        let sum = build.binary(Opcode::Add, nine, ten, Flags::default());
8170        build.func().declare_value(sum, 41);
8171        build.ret(&[sum]);
8172
8173        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8174            .expect("every instruction has a rule");
8175
8176        // One pair and not three. The constants are values the program never declared, and a
8177        // register holding one of those is nobody's. The register is the one the addition writes,
8178        // which the listing under it is what pins down.
8179        assert_eq!(lowered.func.named, vec![(41, mir::Reg::virtual_reg(1))]);
8180        assert_eq!(
8181            mir::print_func(&lowered.func, &names, &REGS),
8182            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 9\n    \
8183             %1:gpr(reuse 1) = x64.add_ri_32 %0, 10\n    x64.ret_val_32 %1($rax)\n}\n"
8184        );
8185    }
8186
8187    /// A local held in a constant two blocks want is two registers and both of them are it.
8188    ///
8189    /// Why the declaration is written down as each register is handed out rather than once at the
8190    /// end over the map from values to registers. That map remembers the last register a value was
8191    /// written into, and a constant is written again in every block that wants one, so a local held
8192    /// in one would come out findable in the last block of the function and nowhere else.
8193    #[test]
8194    fn a_local_held_in_a_constant_two_blocks_want_is_named_in_both_of_them() {
8195        let i32 = Type::int(32);
8196        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
8197        let then = source.create_block();
8198        let other = source.create_block();
8199        let join = source.create_block();
8200        let got = source.append_param(join, i32);
8201
8202        let mut build = Builder::new(&mut source, entry);
8203        let seven = build.iconst(i32, 7);
8204        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
8205        build.func().declare_value(seven, 41);
8206        build.br_if(cond, then, &[], other, &[]);
8207        Builder::new(&mut source, then).jump(join, &[seven]);
8208        Builder::new(&mut source, other).jump(join, &[seven]);
8209        Builder::new(&mut source, join).ret(&[got]);
8210
8211        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8212            .expect("every instruction has a rule");
8213
8214        let held = &lowered.func.named;
8215        assert_eq!(held.len(), 2, "one register per block that wanted the seven: {held:?}");
8216        assert!(held.iter().all(|&(decl, _)| decl == 41), "{held:?}");
8217        assert_ne!(held[0].1, held[1].1, "the same register in two blocks: {held:?}");
8218    }
8219
8220    /// A parameter the program declared comes out named too, in the register it arrived in.
8221    ///
8222    /// The case the walk over the map at the end is for. A parameter is put in a register the
8223    /// convention chose rather than in a fresh one, so nothing asks the mint for it and the pair
8224    /// would otherwise never be written down.
8225    #[test]
8226    fn a_parameter_the_program_declared_says_which_register_it_arrived_in() {
8227        let i32 = Type::int(32);
8228        let (mut names, mut source, block, args) = blank(&[i32]);
8229        let mut build = Builder::new(&mut source, block);
8230        build.func().declare_value(args[0], 41);
8231        build.ret(&[args[0]]);
8232
8233        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8234            .expect("every instruction has a rule");
8235
8236        let held = &lowered.func.named;
8237        assert_eq!(held.len(), 1, "one pair for the one parameter: {held:?}");
8238        assert_eq!(held[0].0, 41);
8239    }
8240
8241    /// A function with nothing declared in it says nothing, which is every function compiled
8242    /// without debugging information asked for.
8243    #[test]
8244    fn a_function_the_front_end_named_nothing_in_names_no_registers() {
8245        let (mut names, mut source, block, _) = blank(&[]);
8246        let mut build = Builder::new(&mut source, block);
8247        let nine = build.iconst(Type::int(32), 9);
8248        build.ret(&[nine]);
8249
8250        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8251            .expect("every instruction has a rule");
8252        assert!(lowered.func.named.is_empty(), "{:?}", lowered.func.named);
8253    }
8254
8255    #[test]
8256    fn the_frame_is_what_fills_the_address_of_a_local_in() {
8257        let (mut names, mut source, block, _) = blank(&[]);
8258        let slot = slot(&mut source, block, 4, 4);
8259        let mut build = Builder::new(&mut source, block);
8260        let nine = build.iconst(Type::int(32), 9);
8261        build.store(nine, slot, plain(), Flags::default());
8262        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
8263        build.ret(&[loaded]);
8264
8265        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8266            .expect("every instruction has a rule");
8267        let stack = lowered.stack;
8268        let mut out = lowered.func;
8269        let env = env();
8270        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
8271        let layout = stack.layout(Layout::new(&SYSV, REGS));
8272        let frame = Frame::of(&out, &allocation, &layout);
8273        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
8274
8275        // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
8276        // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
8277        // never moves and the four bytes are below it, which is what the negative offset is. The
8278        // instruction the lowering left with nothing in its displacement now has the answer in it.
8279        let text = mir::print_func(&out, &names, &REGS);
8280        assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
8281        assert!(!text.contains("x64.sub_ri_64"), "{text}");
8282        assert_eq!(frame.size(), 0);
8283        assert_eq!(frame.local(0), Some(-8));
8284    }
8285
8286    /// An `alloca` whose size is an operand, which is a variable length array.
8287    fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
8288        let info = MemInfo { size: 0, align, ..plain() };
8289        let mut build = Builder::new(source, block);
8290        let mem = build.func().add_mem(info);
8291        let args = build.func().push_values(&[size]);
8292        build.value(
8293            InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
8294            Type::PTR,
8295        )
8296    }
8297
8298    #[test]
8299    fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
8300        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8301        let slot = growing(&mut source, block, args[0], 16);
8302        Builder::new(&mut source, block).ret(&[slot]);
8303
8304        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8305            .expect("every instruction has a rule");
8306
8307        // The bytes come off the stack pointer where the declaration stands and the address is
8308        // where the stack pointer then is, which is one subtraction and one `lea` rather than a
8309        // slot the frame laid out. Nothing is on the list of locals, because there is nothing
8310        // about this the frame could place.
8311        let text = mir::print_func(&lowered.func, &names, &REGS);
8312        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
8313        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
8314        assert!(lowered.stack.locals.is_empty(), "{text}");
8315        assert_eq!(lowered.stack.dynamic.len(), 1);
8316        assert!(lowered.stack.grown_at.is_some());
8317    }
8318
8319    #[test]
8320    fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
8321        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8322        let slot = growing(&mut source, block, args[0], 32);
8323        Builder::new(&mut source, block).ret(&[slot]);
8324
8325        // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
8326        // for means masking the stack pointer after moving it, and after that no constant reaches
8327        // the rest of the frame from the frame pointer either. A second pointer held for the
8328        // purpose is what fixes it and there is not one yet.
8329        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8330            .expect_err("nothing realigns a frame that grows");
8331        assert_eq!(
8332            failed.to_string(),
8333            "this local wants more alignment than the stack pointer is left on, which needs a \
8334             base register nothing here keeps"
8335        );
8336    }
8337
8338    #[test]
8339    fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
8340        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8341        let fixed = slot(&mut source, block, 4, 4);
8342        let mut build = Builder::new(&mut source, block);
8343        let nine = build.iconst(Type::int(32), 9);
8344        build.store(nine, fixed, plain(), Flags::default());
8345        let grown = growing(&mut source, block, args[0], 16);
8346        Builder::new(&mut source, block).ret(&[grown]);
8347
8348        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8349            .expect("every instruction has a rule");
8350        let stack = lowered.stack;
8351        let mut out = lowered.func;
8352        let env = env();
8353        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
8354        let layout = stack.layout(Layout::new(&SYSV, REGS));
8355        let frame = Frame::of(&out, &allocation, &layout);
8356        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
8357
8358        // The stack pointer moves in the middle of the function, so the four bytes of the fixed
8359        // local are not a constant away from it any more and the frame pointer is what reaches
8360        // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
8361        // living in the red zone, and the address of the growing slot is off the stack pointer as
8362        // it stands after the subtraction rather than off anything the prologue left.
8363        let text = mir::print_func(&out, &names, &REGS);
8364        assert!(frame.grows());
8365        assert!(frame.frame_pointer());
8366        assert!(frame.size() > 0, "{text}");
8367        assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
8368        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
8369        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
8370    }
8371
8372    #[test]
8373    fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
8374        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
8375        let mut build = Builder::new(&mut source, block);
8376        let stepped = build.func().push_values(&[args[0], args[1]]);
8377        let next =
8378            build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
8379        let loaded = build.load(Type::int(32), next, plain(), Flags::default());
8380        build.ret(&[loaded]);
8381
8382        // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
8383        // in the rule set, which is the point: the two addresses arrive in registers because an
8384        // address is an integer as wide as one, and the arithmetic on them is the add it always
8385        // was, so every rule written about an add reaches it.
8386        //
8387        // The add stays its own instruction here rather than folding into the address the load
8388        // reads from. Two registers with no scale on either is the one addressing mode the rules
8389        // have no load through, because the folds that exist are the displacement one and the
8390        // scaled ones, and this is neither. `crate::fold` is what puts the two together, after
8391        // selection, and this is the pair it is handed.
8392        assert_eq!(
8393            lower(&mut names, &source),
8394            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
8395             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
8396             %3:gpr = x64.mov_rm_32 [%2]\n    x64.ret_val_32 %3($rax)\n}\n"
8397        );
8398    }
8399
8400    /// The address of a file scope name, which is what every use of a global and every string
8401    /// literal starts from.
8402    fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
8403        let symbol = names.intern(name);
8404        let mut build = Builder::new(source, block);
8405        build.value(
8406            InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
8407            Type::PTR,
8408        )
8409    }
8410
8411    #[test]
8412    fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
8413        let (mut names, mut source, block, _) = blank(&[]);
8414        let counter = address_of(&mut source, block, &mut names, "counter");
8415        let mut build = Builder::new(&mut source, block);
8416        let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
8417        build.ret(&[loaded]);
8418
8419        // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
8420        // that names no register and carries the symbol, which is what the assembler writes
8421        // relative to `%rip` and what the object writer leaves a relocation for.
8422        assert_eq!(
8423            lower(&mut names, &source),
8424            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [@counter]\n    \
8425             %1:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %1($rax)\n}\n"
8426        );
8427    }
8428
8429    #[test]
8430    fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
8431        let (mut names, mut source, block, _) = blank(&[]);
8432        let away = address_of(&mut source, block, &mut names, "away");
8433        Builder::new(&mut source, block).ret(&[away]);
8434        let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
8435
8436        // `extern void away(void); void *f(void) { return away; }`. A load and not an address
8437        // computation, because the distance from here to a name a shared library may be the one
8438        // that defines is not a number any link can work out, and the slot the linker fills in is
8439        // in this program and so is a distance it has.
8440        let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8441            .expect("every instruction has a rule");
8442        assert_eq!(
8443            mir::print_func(&out.func, &names, &REGS),
8444            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [got @away]\n    \
8445             x64.ret_val_64 %0($rax)\n}\n"
8446        );
8447    }
8448
8449    #[test]
8450    fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
8451        let (mut names, mut source, block, _) = blank(&[]);
8452        let own = address_of(&mut source, block, &mut names, "own");
8453        Builder::new(&mut source, block).ret(&[own]);
8454        let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
8455
8456        // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
8457        // the two cases above are one, because there is no address to load or to work out: the
8458        // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
8459        // thread's block starts, and the sum of the two is this thread's copy.
8460        let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8461            .expect("every instruction has a rule");
8462        assert_eq!(
8463            mir::print_func(&out.func, &names, &REGS),
8464            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [thread @own]\n    \
8465             %1:gpr = x64.mov_rm_64 [fs:0]\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
8466             x64.ret_val_64 %2($rax)\n}\n"
8467        );
8468    }
8469
8470    /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
8471    #[test]
8472    fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
8473        let (mut names, mut source, block, _) = blank(&[]);
8474        let here =
8475            Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
8476        Builder::new(&mut source, block).ret(&[here]);
8477
8478        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8479            .expect("every instruction has a rule");
8480        assert_eq!(
8481            mir::print_func(&out.func, &names, &REGS),
8482            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
8483             x64.ret_val_64 %0($rax)\n}\n"
8484        );
8485    }
8486
8487    /// One `asm` statement, with its template and its constraint list written as a program does.
8488    fn assembly(
8489        source: &mut Func,
8490        block: Block,
8491        names: &mut Interner,
8492        template: &str,
8493        constraints: &str,
8494        args: &[Value],
8495        results: &[Type],
8496    ) -> Inst {
8497        clobbering(source, block, names, template, constraints, "memory", args, results)
8498    }
8499
8500    /// The same with a clobber list of its own, for the statements that are about one.
8501    #[allow(clippy::too_many_arguments)]
8502    fn clobbering(
8503        source: &mut Func,
8504        block: Block,
8505        names: &mut Interner,
8506        template: &str,
8507        constraints: &str,
8508        clobbers: &str,
8509        args: &[Value],
8510        results: &[Type],
8511    ) -> Inst {
8512        let info = AsmInfo {
8513            template: names.intern(template),
8514            constraints: names.intern(constraints),
8515            clobbers: names.intern(clobbers),
8516            targets: rucc_ir::BlockCallList::EMPTY,
8517        };
8518        Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
8519    }
8520
8521    /// What a program asking the processor what it can do writes, which is the instruction whose
8522    /// every operand is a register its text does not name.
8523    #[test]
8524    fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
8525        let u32 = Type::int(32);
8526        let (mut names, mut source, block, _) = blank(&[]);
8527        let zero = Builder::new(&mut source, block).iconst(u32, 0);
8528        let out = clobbering(
8529            &mut source,
8530            block,
8531            &mut names,
8532            "cpuid",
8533            "=a,a",
8534            "ebx,ecx,edx",
8535            &[zero],
8536            &[u32],
8537        );
8538        let produced = source[out].results().next().expect("one result");
8539        Builder::new(&mut source, block).ret(&[produced]);
8540
8541        // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
8542        // every program that has a faster path on some machines writes. Four registers written and
8543        // two read, none of them in the template, all of them out of the description, and the two
8544        // that the letters named are the statement's own. The subleaf is a zero because the
8545        // instruction reads `ecx` and the program said nothing about what is in it. The three
8546        // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
8547        // register with two definitions.
8548        assert_eq!(
8549            lower(&mut names, &source),
8550            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    \
8551             %1:gpr = x64.mov_ri_64 0\n    \
8552             %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
8553             %1($rcx)\n    x64.ret_val_32 %2($rax)\n}\n"
8554        );
8555    }
8556
8557    /// An operand the program pinned, by declaring the object it comes from `register long x asm
8558    /// ("r12")`. The letter on its own leaves the allocator to pick, and a template that reads the
8559    /// register by name needs the two to be the same register, so the brace is what ties them
8560    /// together. That is the one use of a local register variable the GNU manual calls reliable,
8561    /// and it is what tcc's `tests/tcctest.c` counts on.
8562    #[test]
8563    fn an_operand_the_program_pinned_is_placed_in_the_register_it_named() {
8564        let u64 = Type::int(64);
8565        let (mut names, mut source, block, _) = blank(&[]);
8566        let out =
8567            assembly(&mut source, block, &mut names, "mov $0x4542, %r12", "=r{r12}", &[], &[u64]);
8568        let produced = source[out].results().next().expect("one result");
8569        Builder::new(&mut source, block).ret(&[produced]);
8570
8571        // The template is one instruction the table already has, so it lowers to that instruction
8572        // rather than to text nobody read, and the register it names is the statement's own output
8573        // because the brace put the output there. Without the brace the letter would have let the
8574        // allocator pick, the two `%r12` would have been different registers, and the program would
8575        // have come back with whatever was in the one it picked.
8576        assert_eq!(
8577            lower(&mut names, &source),
8578            "mfunc @f {\nblock0:\n    %0:gpr($r12) = x64.mov_ri_64 17730\n    \
8579             x64.ret_val_64 %0($rax)\n}\n"
8580        );
8581    }
8582
8583    /// A clobber the instruction does not write itself, which is the case the list is there for.
8584    /// It goes on as a definition of the register, in among the other definitions, because that is
8585    /// the whole of how a machine function says a register is not worth anything after this.
8586    #[test]
8587    fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
8588        let (mut names, mut source, block, _) = blank(&[]);
8589        clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
8590        Builder::new(&mut source, block).ret(&[]);
8591
8592        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    $rsi = x64.pause\n}\n");
8593    }
8594
8595    /// A clobber naming something this has no register for. Refused rather than dropped, since the
8596    /// list is the program saying which registers it may not leave anything in, and an entry
8597    /// nobody read is a register something may still be left in.
8598    #[test]
8599    fn a_clobber_this_has_no_register_for_is_refused() {
8600        let (mut names, mut source, block, _) = blank(&[]);
8601        clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
8602        Builder::new(&mut source, block).ret(&[]);
8603
8604        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8605            .expect_err("there is no such register here");
8606        assert_eq!(
8607            failed.to_string(),
8608            "this `asm` says it destroys a register this has no name for"
8609        );
8610    }
8611
8612    #[test]
8613    fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
8614        let (mut names, mut source, block, _) = blank(&[]);
8615        assembly(&mut source, block, &mut names, "", "", &[], &[]);
8616        Builder::new(&mut source, block).ret(&[]);
8617
8618        // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
8619        // spent on the optimizer, which has finished by now, so what is left is nothing.
8620        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
8621    }
8622
8623    #[test]
8624    fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
8625        let i32 = Type::int(32);
8626        let (mut names, mut source, block, args) = blank(&[i32]);
8627        let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
8628        let produced = source[out].results().next().expect("one result");
8629        Builder::new(&mut source, block).ret(&[produced]);
8630
8631        // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
8632        // value without changing it. The two share a place and the template writes nothing over
8633        // it, so the value comes back out of the register it went in.
8634        assert_eq!(
8635            lower(&mut names, &source),
8636            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
8637             x64.ret_val_32 %0($rax)\n}\n"
8638        );
8639    }
8640
8641    #[test]
8642    fn an_output_written_plus_is_the_same_rename() {
8643        let i32 = Type::int(32);
8644        let (mut names, mut source, block, args) = blank(&[i32]);
8645        let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
8646        let produced = source[out].results().next().expect("one result");
8647        Builder::new(&mut source, block).ret(&[produced]);
8648
8649        // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
8650        assert_eq!(
8651            lower(&mut names, &source),
8652            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
8653             x64.ret_val_32 %0($rax)\n}\n"
8654        );
8655    }
8656
8657    #[test]
8658    fn an_output_nothing_is_tied_to_is_a_zero() {
8659        let i32 = Type::int(32);
8660        let (mut names, mut source, block, _) = blank(&[]);
8661        let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
8662        let produced = source[out].results().next().expect("one result");
8663        Builder::new(&mut source, block).ret(&[produced]);
8664
8665        // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
8666        // an empty template leaves nothing. A definite value rather than a register nothing wrote,
8667        // because the allocator is owed a definition before the use however little the program is.
8668        assert_eq!(
8669            lower(&mut names, &source),
8670            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
8671        );
8672    }
8673
8674    #[test]
8675    fn a_template_that_is_one_instruction_becomes_that_instruction() {
8676        let (mut names, mut source, block, _) = blank(&[]);
8677        assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
8678        Builder::new(&mut source, block).ret(&[]);
8679
8680        // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
8681        // instruction, no operands, and nothing between the template and the machine but the table
8682        // that already says what a `pause` is.
8683        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    x64.pause\n}\n");
8684    }
8685
8686    #[test]
8687    fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
8688        let i64 = Type::int(64);
8689        let (mut names, mut source, block, _) = blank(&[]);
8690        let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
8691        let produced = source[out].results().next().expect("one result");
8692        Builder::new(&mut source, block).ret(&[produced]);
8693
8694        // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
8695        // thread owns. The same instruction `crate::lower` already writes for a thread-local
8696        // variable, reached this time because a program wrote it out by hand.
8697        assert_eq!(
8698            lower(&mut names, &source),
8699            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
8700             x64.ret_val_64 %0($rax)\n}\n"
8701        );
8702    }
8703
8704    /// A template this cannot read is kept as its text, which is what gcc does with every template.
8705    /// Whether the text is an instruction is the assembler's question, asked when the unit is
8706    /// assembled from its listing.
8707    #[test]
8708    fn a_template_naming_an_instruction_this_machine_has_not_got_is_kept_as_text() {
8709        let (mut names, mut source, block, _) = blank(&[]);
8710        assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
8711        Builder::new(&mut source, block).ret(&[]);
8712
8713        let printed = lower(&mut names, &source);
8714        assert!(printed.contains("x64.template"), "{printed}");
8715        assert!(printed.contains("@hcf"), "{printed}");
8716    }
8717
8718    /// A template kept as text with an operand in a register reads the operand, and its text holds
8719    /// a hole naming that operand of the instruction, which the writer fills with the register the
8720    /// allocator chose. The input is the instruction's only use, behind every register a call may
8721    /// write.
8722    #[test]
8723    fn a_template_kept_as_text_reads_an_operand_in_a_register_through_a_hole() {
8724        let i32 = Type::int(32);
8725        let (mut names, mut source, block, args) = blank(&[i32]);
8726        assembly(&mut source, block, &mut names, "hcf %0", "r", &[args[0]], &[]);
8727        Builder::new(&mut source, block).ret(&[]);
8728
8729        let printed = lower(&mut names, &source);
8730        let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8731        // Twenty five registers are written ahead of it, so the operand read is the twenty sixth,
8732        // spelled at the width of an `int`.
8733        assert!(line.contains("x64.template %0, @hcf \u{1}r25k\u{2}"), "{printed}");
8734        assert!(line.contains("early $rax"), "{printed}");
8735    }
8736
8737    /// A template kept as text with more outputs than the convention keeps registers across a call
8738    /// gets back as many of the registers a call may write as it needs, from the end of the order,
8739    /// and keeps the rest. Six outputs against five preserved registers is one handed back, which is
8740    /// `r9`. `r11` and `r10` come back ahead of it without counting, since they are the allocator's
8741    /// scratch and no operand is given one, but an output it spills is carried in one of them, which
8742    /// it cannot be while the template claims it. The shape is `sodium_sub` in libsodium, whose
8743    /// `sbbq` into memory the reader has no form for, and before this the allocator ran out of
8744    /// registers on it.
8745    #[test]
8746    fn a_template_kept_as_text_with_more_outputs_than_are_kept_gets_registers_back() {
8747        let i64 = Type::int(64);
8748        let (mut names, mut source, block, _) = blank(&[]);
8749        let outputs = [i64; 6];
8750        let asm = assembly(
8751            &mut source,
8752            block,
8753            &mut names,
8754            "hcf %0, %1, %2, %3, %4, %5",
8755            "=&r,=&r,=&r,=&r,=&r,=&r",
8756            &[],
8757            &outputs,
8758        );
8759        let produced: Vec<Value> = source[asm].results().collect();
8760        Builder::new(&mut source, block).ret(&produced[..1]);
8761
8762        let printed = lower(&mut names, &source);
8763        let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8764        assert!(line.contains("early $r8"), "{printed}");
8765        for reg in ["r9", "r10", "r11"] {
8766            assert!(!line.contains(&format!("early ${reg}")), "{printed}");
8767        }
8768    }
8769
8770    /// A register the template named is placed as itself, fixed to the register the program wrote
8771    /// down. A register a constraint letter names is a different thing and is placed too, which the
8772    /// test above is about: there the statement said which of its own operands is in the register,
8773    /// and a name in the middle of a template says the register and nothing about any operand.
8774    #[test]
8775    fn a_template_naming_a_register_gets_that_register() {
8776        let i64 = Type::int(64);
8777        let (mut names, mut source, block, _) = blank(&[]);
8778        let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
8779        let produced = source[out].results().next().expect("one result");
8780        Builder::new(&mut source, block).ret(&[produced]);
8781
8782        // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
8783        // The source is the register itself and the destination is one the allocator picks.
8784        assert_eq!(
8785            lower(&mut names, &source),
8786            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rax($rax)\n    \
8787             x64.ret_val_64 %0($rax)\n}\n"
8788        );
8789    }
8790
8791    /// The half of the same thing every register saving template needs. micropython writes the
8792    /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
8793    /// of that line are a register the template named: the one being stored and the one the address
8794    /// is counted from.
8795    #[test]
8796    fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
8797        let (mut names, mut source, block, _) = blank(&[]);
8798        assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
8799        Builder::new(&mut source, block).ret(&[]);
8800
8801        assert_eq!(
8802            lower(&mut names, &source),
8803            "mfunc @f {\nblock0:\n    x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
8804        );
8805    }
8806
8807    /// A local kept in a named register, which is the same register named as itself and reached
8808    /// from the other side. micropython's collector writes six of these and reads them with
8809    /// ordinary C rather than with a template.
8810    #[test]
8811    fn a_local_kept_in_a_named_register_is_one_move_out_of_it() {
8812        let (mut names, mut source, block, _) = blank(&[]);
8813        let held = names.intern("rbx");
8814        let value = Builder::new(&mut source, block).value(
8815            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8816            Type::int(64),
8817        );
8818        Builder::new(&mut source, block).ret(&[value]);
8819
8820        assert_eq!(
8821            lower(&mut names, &source),
8822            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rbx($rbx)\n    \
8823             x64.ret_val_64 %0($rax)\n}\n"
8824        );
8825    }
8826
8827    /// The sigil gcc allows in front of the name is syntax and comes off, and a name that is not
8828    /// a register of this machine is refused in words that say which name it was.
8829    #[test]
8830    fn a_register_name_is_read_with_or_without_its_sigil_and_refused_when_there_is_no_such_one() {
8831        for written in ["%r12", "r12"] {
8832            let (mut names, mut source, block, _) = blank(&[]);
8833            let held = names.intern(written);
8834            let value = Builder::new(&mut source, block).value(
8835                InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8836                Type::int(64),
8837            );
8838            Builder::new(&mut source, block).ret(&[value]);
8839            assert!(lower(&mut names, &source).contains("$r12($r12)"), "{written} is not read");
8840        }
8841
8842        let (mut names, mut source, block, _) = blank(&[]);
8843        let held = names.intern("nowhere");
8844        let value = Builder::new(&mut source, block).value(
8845            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8846            Type::int(64),
8847        );
8848        Builder::new(&mut source, block).ret(&[value]);
8849
8850        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8851            .expect_err("there is no such register");
8852        assert_eq!(
8853            failed.to_string(),
8854            "this object is kept in `nowhere`, which is not a register this machine has"
8855        );
8856    }
8857
8858    #[test]
8859    fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
8860        let i32 = Type::int(32);
8861        let (mut names, mut source, block, args) = blank(&[i32]);
8862        assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
8863        Builder::new(&mut source, block).ret(&[]);
8864
8865        // An output with no result to be, which is what the front end never writes and what a
8866        // hand written module can. Refused rather than placed by a guess.
8867        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8868            .expect_err("the list and the instruction disagree");
8869        assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
8870    }
8871
8872    /// A cast between a pointer and an integer, at whatever width the result is asked for.
8873    fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
8874        let mut build = Builder::new(source, block);
8875        let args = build.func().push_values(&[from]);
8876        build.value(InstData { args, ..InstData::new(opcode) }, to)
8877    }
8878
8879    #[test]
8880    fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
8881        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8882        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
8883        Builder::new(&mut source, block).ret(&[number]);
8884
8885        // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
8886        // as the machine addresses, so the cast changes what the type system calls the value and
8887        // changes nothing about the value, and the register holding it is the one that held it.
8888        assert_eq!(
8889            lower(&mut names, &source),
8890            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
8891             x64.ret_val_64 %0($rax)\n}\n"
8892        );
8893    }
8894
8895    #[test]
8896    fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
8897        let (mut names, mut source, block, _) = blank(&[]);
8898        let mut build = Builder::new(&mut source, block);
8899        let zero = build.iconst(Type::int(64), 0);
8900        let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
8901        Builder::new(&mut source, block).ret(&[null]);
8902
8903        // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
8904        // writes the zero down: a constant is materialized where it is wanted rather than where
8905        // the IR defined it, and without the read there would be no instruction at all.
8906        assert_eq!(
8907            lower(&mut names, &source),
8908            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_64 0\n    x64.ret_val_64 %0($rax)\n}\n"
8909        );
8910    }
8911
8912    #[test]
8913    fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
8914        let readings = [
8915            (Linkage::External, mir::Binding::Global),
8916            (Linkage::Common, mir::Binding::Global),
8917            (Linkage::Internal, mir::Binding::Local),
8918            (Linkage::Weak, mir::Binding::Weak),
8919            (Linkage::LinkOnce, mir::Binding::Weak),
8920        ];
8921        for (linkage, wanted) in readings {
8922            let (mut names, mut source, block, _) = blank(&[]);
8923            source.linkage = linkage;
8924            Builder::new(&mut source, block).ret(&[]);
8925            let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8926                .expect("a return");
8927            // The narrowing is done here rather than where the object is written, because a
8928            // machine function is all the assembler and the writer are ever handed.
8929            assert_eq!(out.func.binding, wanted, "{linkage:?}");
8930        }
8931    }
8932
8933    /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
8934    /// three of them.
8935    ///
8936    /// Here for the reason the linkage above is here. A machine function is the whole of what the
8937    /// assembler and the object writer are handed, so a fact about the symbol that does not get
8938    /// onto one is a fact that is gone by the time anything could write it down, and the way that
8939    /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
8940    #[test]
8941    fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
8942        let readings = [
8943            (Visibility::Default, mir::Visibility::Default),
8944            (Visibility::Hidden, mir::Visibility::Hidden),
8945            (Visibility::Protected, mir::Visibility::Protected),
8946        ];
8947        for (visibility, wanted) in readings {
8948            let (mut names, mut source, block, _) = blank(&[]);
8949            source.visibility = visibility;
8950            Builder::new(&mut source, block).ret(&[]);
8951            let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8952                .expect("a return");
8953            assert_eq!(out.func.visibility, wanted, "{visibility:?}");
8954        }
8955    }
8956
8957    #[test]
8958    fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
8959        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8960        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
8961        Builder::new(&mut source, block).ret(&[number]);
8962
8963        // The front end never writes one: it casts at the address width and truncates or extends
8964        // around it, so both of those are the rules they always were. IR from somewhere else that
8965        // does write one is refused rather than compiled to a move that keeps the high half.
8966        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8967            .expect_err("no rule narrows an address");
8968        assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
8969    }
8970
8971    /// The type this machine has no register for.
8972    fn long_double() -> Type {
8973        Type::float(rucc_ir::Float::F80)
8974    }
8975
8976    #[test]
8977    fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
8978        let f64 = Type::float(rucc_ir::Float::F64);
8979        let (mut names, mut source, block, args) = blank(&[f64]);
8980        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8981        let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8982        Builder::new(&mut source, block).ret(&[back]);
8983
8984        // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
8985        // else, so the value is written to the crossing slot, loaded at the format that widens it
8986        // and put in the slot the eighty bit value lives in. Coming back is the same three the
8987        // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
8988        // every address in a frame looks like here until `finish` has the numbers.
8989        assert_eq!(
8990            lower(&mut names, &source),
8991            "mfunc @f {\nblock0:\n    \
8992             %0:xmm($xmm0) = x64.arg_val_f64\n    \
8993             %1:gpr = x64.lea_64 [$rsp]\n    \
8994             %2:gpr = x64.lea_64 [$rsp]\n    \
8995             x64.movsd_mr %0, [%1]\n    \
8996             x64.fld_l [%1]\n    \
8997             x64.fstp_t [%2]\n    \
8998             %3:gpr = x64.lea_64 [$rsp]\n    \
8999             %4:gpr = x64.lea_64 [$rsp]\n    \
9000             x64.fld_t [%3]\n    \
9001             x64.fstp_l [%4]\n    \
9002             %5:xmm = x64.movsd_rm [%4]\n    \
9003             x64.ret_val_f64 %5($xmm0)\n}\n"
9004        );
9005    }
9006
9007    #[test]
9008    fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
9009        let f64 = Type::float(rucc_ir::Float::F64);
9010        let (mut names, mut source, block, args) = blank(&[f64]);
9011        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9012        let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
9013        let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
9014        let mut build = Builder::new(&mut source, block);
9015        let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
9016        build.ret(&[sum]);
9017
9018        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9019            .expect("every instruction is written");
9020
9021        // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
9022        // psABI says one takes and is aligned to, and eight for the crossing, which every group
9023        // in the function shares because nothing is ever left in it. The value's slot is its own
9024        // for the whole function, so reading it twice reads the same sixteen bytes.
9025        assert_eq!(
9026            out.stack.locals,
9027            vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
9028        );
9029    }
9030
9031    #[test]
9032    fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
9033        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
9034        let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
9035        let back =
9036            cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
9037        Builder::new(&mut source, block).ret(&[back]);
9038
9039        // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
9040        // format, so the conversion is the load and there is no instruction that converts.
9041        let text = lower(&mut names, &source);
9042        assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
9043        assert!(text.contains("x64.fild_ll [%1]"), "{text}");
9044    }
9045
9046    #[test]
9047    fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
9048        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
9049        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9050        let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
9051        Builder::new(&mut source, block).ret(&[whole]);
9052
9053        // The one conversion here with no single instruction behind it. C cuts towards zero and
9054        // the unit rounds the way its control word says, so the word is saved, ORed with the two
9055        // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
9056        // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
9057        let text = lower(&mut names, &source);
9058        let group: Vec<&str> = text
9059            .lines()
9060            .map(str::trim)
9061            .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
9062            .collect();
9063        assert_eq!(
9064            group,
9065            [
9066                "x64.fld_l [%1]",
9067                "x64.fstp_t [%2]",
9068                "x64.fnstcw [%5]",
9069                "%6:gpr = x64.mov_rm_16 [%5]",
9070                "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
9071                "x64.mov_mr_16 %7, [%5 + 2]",
9072                "x64.fldcw [%5 + 2]",
9073                "x64.fld_t [%3]",
9074                "x64.fistp_l [%4]",
9075                "x64.fldcw [%5]",
9076            ],
9077            "{text}"
9078        );
9079    }
9080
9081    #[test]
9082    fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
9083        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
9084        let mut build = Builder::new(&mut source, block);
9085        let value = build.load(long_double(), args[0], plain(), Flags::default());
9086        build.store(value, args[1], plain(), Flags::default());
9087        build.ret(&[]);
9088
9089        // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
9090        // format the value is already in, which neither converts nor looks: a signalling NaN stays
9091        // one and nothing is raised, which is the whole of what makes it a copy.
9092        let text = lower(&mut names, &source);
9093        let group: Vec<&str> =
9094            text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
9095        assert_eq!(
9096            group,
9097            ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
9098            "{text}"
9099        );
9100    }
9101
9102    /// Two `long double` values, from two `double` parameters, and the instructions that made
9103    /// them, which every test below this one throws away.
9104    fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
9105        let left = cast(source, block, Opcode::FPExt, args[0], long_double());
9106        let right = cast(source, block, Opcode::FPExt, args[1], long_double());
9107        (left, right)
9108    }
9109
9110    /// The x87 instructions of a function, in order, with everything else dropped.
9111    fn stack_only(text: &str) -> Vec<&str> {
9112        text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
9113    }
9114
9115    /// The two frame slots the last two addresses of a function were taken of, which in a
9116    /// comparison are the two operands in the order they go on the stack.
9117    fn pushed(out: &Lowered) -> Vec<usize> {
9118        let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
9119        taken[taken.len() - 2..].to_vec()
9120    }
9121
9122    #[test]
9123    fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
9124        let f64 = Type::float(rucc_ir::Float::F64);
9125        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9126        let (left, right) = two_long_doubles(&mut source, block, &args);
9127        let sum =
9128            Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
9129        let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
9130        Builder::new(&mut source, block).ret(&[back]);
9131
9132        // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
9133        // four lines are the add: both operands pushed, the instruction that names neither of
9134        // them because they are the top two of a stack, and the answer taken off into its slot.
9135        let text = lower(&mut names, &source);
9136        assert_eq!(
9137            stack_only(&text),
9138            [
9139                "x64.fld_l [%2]",
9140                "x64.fstp_t [%3]",
9141                "x64.fld_l [%4]",
9142                "x64.fstp_t [%5]",
9143                "x64.fld_t [%6]",
9144                "x64.fld_t [%7]",
9145                "x64.fadd_p",
9146                "x64.fstp_t [%8]",
9147                "x64.fld_t [%9]",
9148                "x64.fstp_l [%10]",
9149            ],
9150            "{text}"
9151        );
9152    }
9153
9154    #[test]
9155    fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
9156        let f64 = Type::float(rucc_ir::Float::F64);
9157        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9158        let (left, right) = two_long_doubles(&mut source, block, &args);
9159        let less =
9160            Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
9161        let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
9162        Builder::new(&mut source, block).ret(&[back]);
9163
9164        // The left one goes on first, so it ends up under the right one, and the answer wanted is
9165        // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
9166        // and computes the other one. The `r` says which spelling this is and not which order the
9167        // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
9168        // name is what got this wrong the first time.
9169        let text = lower(&mut names, &source);
9170        assert_eq!(
9171            &stack_only(&text)[4..8],
9172            ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
9173            "{text}"
9174        );
9175    }
9176
9177    #[test]
9178    fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
9179        let f64 = Type::float(rucc_ir::Float::F64);
9180        let (mut names, mut source, block, args) = blank(&[f64]);
9181        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9182        let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
9183        let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
9184        Builder::new(&mut source, block).ret(&[back]);
9185
9186        // `fchs` and not a subtraction from zero, which would give a different answer at a negative
9187        // zero and would signal at a NaN. It does not read the value as a number at all.
9188        let text = lower(&mut names, &source);
9189        assert_eq!(
9190            &stack_only(&text)[2..5],
9191            ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
9192            "{text}"
9193        );
9194    }
9195
9196    #[test]
9197    fn comparing_two_long_doubles_puts_the_left_one_on_top() {
9198        let f64 = Type::float(rucc_ir::Float::F64);
9199        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9200        let (left, right) = two_long_doubles(&mut source, block, &args);
9201        let mut build = Builder::new(&mut source, block);
9202        build.fcmp(FloatPred::Ogt, left, right, Flags::default());
9203        build.ret(&[]);
9204
9205        // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
9206        // operand the predicate is about has to go on last, which is the other way round from the
9207        // arithmetic above. The pop that clears the loser and the byte that reads the flags are
9208        // both inside the one opcode.
9209        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9210            .expect("every instruction is written");
9211        let slots = pushed(&out);
9212        assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
9213        let text = mir::print_func(&out.func, &names, &REGS);
9214        assert_eq!(
9215            &stack_only(&text)[4..],
9216            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
9217            "{text}"
9218        );
9219    }
9220
9221    #[test]
9222    fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
9223        let f64 = Type::float(rucc_ir::Float::F64);
9224        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9225        let (left, right) = two_long_doubles(&mut source, block, &args);
9226        let mut build = Builder::new(&mut source, block);
9227        build.fcmp(FloatPred::Olt, left, right, Flags::default());
9228        build.ret(&[]);
9229
9230        // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
9231        // the operands the other way round. The same trade the vector rules make, and it has to
9232        // be the same one: a `long double` comparison that picked a different condition from the
9233        // `double` comparison of the same two numbers would be wrong at exactly the unordered
9234        // cases the two conditions differ on.
9235        //
9236        // Which slot each push names is the whole of the difference from the test above, and the
9237        // text does not show it, since an address in a frame is a `lea` with nothing in it until
9238        // `finish` has the numbers. So the slots are what is read here.
9239        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9240            .expect("every instruction is written");
9241        let slots = pushed(&out);
9242        assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
9243        let text = mir::print_func(&out.func, &names, &REGS);
9244        assert_eq!(
9245            &stack_only(&text)[4..],
9246            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
9247            "{text}"
9248        );
9249    }
9250
9251    #[test]
9252    fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
9253        let f64 = Type::float(rucc_ir::Float::F64);
9254        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9255        let (left, right) = two_long_doubles(&mut source, block, &args);
9256        let mut build = Builder::new(&mut source, block);
9257        build.fcmp(FloatPred::Oeq, left, right, Flags::default());
9258        build.ret(&[]);
9259
9260        // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
9261        // second register as well as the one the value is in and ANDs them together. Said here by
9262        // handing it a spare, since an instruction that wrote a register nothing knew about would
9263        // be an instruction the allocator could put a live value in the way of.
9264        let text = lower(&mut names, &source);
9265        assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
9266    }
9267
9268    #[test]
9269    fn a_comparison_that_is_never_asked_is_reported() {
9270        let f64 = Type::float(rucc_ir::Float::F64);
9271        let (mut names, mut source, block, args) = blank(&[f64, f64]);
9272        let (left, right) = two_long_doubles(&mut source, block, &args);
9273        let mut build = Builder::new(&mut source, block);
9274        build.fcmp(FloatPred::False, left, right, Flags::default());
9275        build.ret(&[]);
9276
9277        // Always false is a constant and not a comparison, so there is no condition to pick and
9278        // nothing here folds it into one: an instruction that quietly agreed with it would hide
9279        // that the optimizer left a comparison in that it should have taken out.
9280        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9281            .expect_err("no condition is always false");
9282        assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
9283    }
9284
9285    #[test]
9286    fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
9287        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
9288        let mut build = Builder::new(&mut source, block);
9289        // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
9290        let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
9291        build.store(one_and_a_half, args[0], plain(), Flags::default());
9292        build.ret(&[]);
9293
9294        // No x87 instruction at all. A slot holding one of these is the value, so a constant is
9295        // its ten bytes written where the value lives, and whatever reads it does the `fld`.
9296        let text = lower(&mut names, &source);
9297        assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
9298        assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
9299        assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
9300        // The six bytes above the ten are the padding that makes the type sixteen wide, and they
9301        // are unspecified rather than zero, so nothing writes them.
9302        assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
9303    }
9304
9305    #[test]
9306    fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
9307        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
9308        let mut build = Builder::new(&mut source, block);
9309        let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
9310        build.store(minus, args[0], plain(), Flags::default());
9311        build.ret(&[]);
9312
9313        // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
9314        // in a register with is above the signed range of sixteen bits and has to stay there: read
9315        // as a number it would be negative, and it is not a number, it is two bytes.
9316        let text = lower(&mut names, &source);
9317        assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
9318    }
9319
9320    #[test]
9321    fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
9322        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
9323        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9324        let next = source.create_block();
9325        let param = source.append_param(next, long_double());
9326        Builder::new(&mut source, block).jump(next, &[wide]);
9327        Builder::new(&mut source, next).ret(&[param]);
9328
9329        // What the edge carries is the address of the slot the value is already in, which is an
9330        // ordinary register the allocator has an opinion about. The block on the other side copies
9331        // the sixteen bytes into a slot of its own before anything reads them, so a second edge
9332        // handing over a second address would still leave one place for a reader to look.
9333        let text = lower(&mut names, &source);
9334        let second: Vec<&str> = text
9335            .lines()
9336            .skip_while(|line| !line.starts_with("block1"))
9337            .skip(1)
9338            .take(3)
9339            .map(str::trim)
9340            .collect();
9341        assert_eq!(
9342            second,
9343            ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
9344            "{text}"
9345        );
9346    }
9347
9348    #[test]
9349    fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
9350        let f64 = Type::float(rucc_ir::Float::F64);
9351        let (mut names, mut source, block, args) = blank(&[f64]);
9352        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
9353        let next = source.create_block();
9354        let params: Vec<Value> =
9355            (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
9356        let carried: Vec<Value> = params.iter().map(|_| wide).collect();
9357        Builder::new(&mut source, block).jump(next, &carried);
9358        Builder::new(&mut source, next).ret(&[params[0]]);
9359
9360        // The copies go through the x87 stack so that every one of them is read before any of them
9361        // is written, which is what makes a block that swaps two of these right. Nine of them do
9362        // not fit on the stack, and copying the ninth before or after the rest is the order that
9363        // could be wrong, so it is refused instead.
9364        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
9365            .expect_err("nine do not fit on the stack");
9366        assert_eq!(
9367            failed.to_string(),
9368            "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
9369        );
9370        assert_eq!(failed.inst(), None);
9371    }
9372}