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, OperandDesc, PhysReg, RegClass, Role, VaList, Variadic,
91};
92use rucc_target::{aarch64, x86_64};
93
94use crate::abi::{self, Missing, Refused};
95use crate::coverage::Fired;
96use crate::elsewhere::Elsewhere;
97use crate::frame::{Layout, Local};
98use crate::select::{Match, Piece, Pointer, Reach, Rule, Selector};
99use crate::term::{MAX_ARGS, PLAIN, Plan, Shown, Term, Terms};
100use crate::varargs;
101
102/// The instruction a template's `jmp` to a name outside it becomes.
103///
104/// The same instruction [`x86_64::FRAME`] names for the end of a tail call, named here as well
105/// because what reaches this one is a template in a function with no prologue and no epilogue,
106/// which is nothing to do with the frame.
107/// See [`x86_64::Step::Away`].
108const AWAY: &str = "jmp_away";
109
110/// How wide an address is on this target, which is the width a cast between a pointer and an
111/// integer has to be at for the cast to be nothing.
112const ADDRESS_BITS: u32 = 64;
113
114/// How much of a register an operand of an `asm` statement fills, which is the width of its type
115/// with two exceptions. A pointer is an address, and a truth value is the byte it is stored in: a
116/// program that writes `sete %0` into a `_Bool` is asking for exactly that byte, which is what tcc's
117/// own test of the width of one checks.
118fn held_bits(ty: Type) -> u32 {
119    if ty.is_ptr() {
120        ADDRESS_BITS
121    } else if ty.bits() == 1 {
122        8
123    } else {
124        ty.bits()
125    }
126}
127
128/// How many bytes a `long double` takes in memory, and what it is aligned to, which are the same
129/// number and are both more than the ten bytes that mean anything.
130///
131/// The psABI's answer rather than a choice here. `sizeof (long double)` is sixteen on this
132/// machine, so an array of them is laid out this way whatever a slot holding one does, and a slot
133/// that agreed with the array is one fewer thing to get wrong.
134const X87_BYTES: u32 = 16;
135
136/// How many values the x87 stack holds at once.
137///
138/// Eight, which is the machine's number rather than a choice here, and it matters in one place:
139/// the parameters of a block are copied through the stack so that they all move at once, and a
140/// block with more of them than this has nowhere to put the ninth.
141const X87_DEPTH: usize = 8;
142
143/// How far into the buffer of a `__builtin_setjmp` each of the four words it writes is.
144///
145/// The first three are gcc's, measured against gcc 16.2.0 on x86-64 at `-O0`: the frame pointer,
146/// the address control comes back to, and the stack pointer, in that order. The fourth is this
147/// compiler's own. gcc has no word for the answer because it writes a second block that sets the
148/// answer to one and is arrived at from the restore, and this writes the answer through memory
149/// instead, for the reason [`Lowering::saves_place`] gives.
150///
151/// None of the four is an interface. The buffer is the program's memory and its five words are
152/// the front end's promise about how much of it there is, but nothing except the matching restore
153/// ever reads a word of it, and a buffer written by one compiler was never going to be one another
154/// compiler could come back through.
155const JUMP_FRAME: i32 = 0;
156
157/// Where the address control comes back to is. See [`JUMP_FRAME`].
158const JUMP_PC: i32 = 8;
159
160/// Where the stack pointer is. See [`JUMP_FRAME`].
161const JUMP_STACK: i32 = 16;
162
163/// Where the address of the word the answer arrives in is. See [`JUMP_FRAME`].
164const JUMP_ANSWER: i32 = 24;
165
166/// How many bytes the word a `__builtin_setjmp` answers with takes in the frame, and what it is
167/// aligned to, which are the same number because it is one machine word.
168const JUMP_WORD: u32 = 8;
169
170/// How many registers the restore needs to hold things in while it puts the frame back.
171///
172/// Four, and every one of them is a register nothing else in the function may be in, which is why
173/// they are counted here rather than asked for one at a time. See [`Lowering::comes_back`].
174const JUMP_REGS: usize = 4;
175
176/// How many bytes the block `__builtin_apply_args` answers takes, which is a word for where the
177/// arguments in memory are, a word of nothing and then the register save area of a variadic
178/// function. See [`Lowering::save_arguments`].
179const APPLY_ARGS: u32 = 192;
180
181/// How far into that block the registers start, which is how far the save area has moved up.
182const APPLY_REGS: u32 = 16;
183
184/// How many bytes the block `__builtin_apply` answers takes, which is two words and two vectors.
185const APPLY_BACK: u32 = 48;
186
187/// How many bytes a value passes through on its way between a register and the x87 stack.
188///
189/// Eight, because the widest thing that crosses is a `double` or a sixty four bit integer, and
190/// nothing crosses at eighty bits: a value that wide is already in the frame and the stack reaches
191/// it where it is.
192const X87_CROSSING: u32 = 8;
193
194/// Where the rounding field of the x87 control word is and what it has to be set to for the unit
195/// to cut towards zero, which is the one rounding C asks for that the unit does not do by default.
196///
197/// Both bits on is truncate. The field is ORed into the word that was already there rather than
198/// written over it, so the precision control and the exception masks somebody else set stay set.
199const X87_TRUNCATE: i64 = 0x0c00;
200
201/// Whether a type is the one this machine has no register for.
202///
203/// Only the eighty bit float is, and that is a fact about x86-64 rather than about floats: every
204/// other scalar the front end produces is in a general purpose register or a vector one, and this
205/// one is on the x87 stack while it is being worked on and in memory the rest of the time. So it
206/// has no place in [`Lowering::class_of`] and no name in [`crate::term`], and every instruction
207/// that touches one is written out by hand in this file.
208fn on_x87(ty: Type) -> bool {
209    ty.is_scalar() && ty.is_float() && ty.bits() == 80
210}
211
212/// Where one operand of an assembly statement is, on each side of the assembly.
213///
214/// Two registers rather than one, because an operand written `+` is a value that arrives and a
215/// value that leaves and those are two values. The machine IR has one definition per register by
216/// construction, so an instruction of the template that reads the operand and writes it has to name
217/// a different register in each place, and what makes the two one register in the end is the
218/// [`Constraint::Reuse`] the instruction's description carries: the allocator reads it, gives both
219/// the same physical register, and copies the incoming value somewhere first when something else is
220/// still using it.
221///
222/// Most operands have one of the two. An input has only a place it is read from and an output
223/// written `=` has only a place it is written to, and asking either of them for the other is an
224/// operand read where the opcode writes or written where it reads, which [`Lowering::placed`]
225/// refuses.
226#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
227struct Place {
228    /// The register the value arrives in, for an operand something reads.
229    read: Option<mir::Reg>,
230    /// The register the value leaves in, for an operand something writes.
231    write: Option<mir::Reg>,
232}
233
234/// Whether that operand of the statement is one the assembly may read, and so where a read of it
235/// gets its value from.
236///
237/// [`bound`] asks this question of an operand a constraint letter named and this asks it of one the
238/// template numbered, which is the same question twice because a two-address instruction reaches
239/// its first source both ways. `mulq %3` reaches `rax` by the letter on the output and libgmp says
240/// what is in it with `"%0"` on an input. `addq %5,%q1` reaches its first source by numbering the
241/// output, and libgmp says what is in it with `"0"` on an input in the same way.
242///
243/// So an output written `=` has no value of its own and is still readable when an input is tied to
244/// it, and the value the read wants is that input's. An output written `+` carries its own value
245/// and answers with that. An output nothing is tied to answers `None`, which is a program that told
246/// the compiler the assembly only writes the operand while the instruction reads it before it
247/// writes it, and is refused where it is asked.
248fn read_as(list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
249    let operand = list.get(index)?;
250    if operand.value.is_some() {
251        return operand.value;
252    }
253    operand.result?;
254    list.iter().find(|entry| entry.tied == Some(index)).and_then(|entry| entry.value)
255}
256
257/// Which of an assembly statement's operands is in that register, for an instruction that reaches
258/// the register without its text saying so.
259///
260/// The constraint is what says so, and it is the only thing in such a statement that could:
261/// `"=a"` is an output in `rax`, `"c"` is an input in `rcx`, an operand that is a local register
262/// variable is in the register its declaration named, and a register nothing names is a register
263/// nobody has said anything about. So a write looks among the outputs and a read among the inputs,
264/// and an output written `+` answers for either, since it is read before it is written. See
265/// [`pinned`], which is the one question asked of both ways of saying it.
266///
267/// The other way a read of such a register is said is a matching constraint. `"=a"` on an output
268/// and `"0"` on an input is the program saying that one register holds the input on the way in and
269/// the output on the way out, and it is how a statement fills a register the instruction reads and
270/// writes without writing the register down twice. The letter is on the output, which has no value
271/// to read, and the value is on the input, which has no letter, and the answer is the output: its
272/// place is read out of the register the input arrived in, and in a template with a loop in it the
273/// place moves on to wherever the last write left it, which is what a read on the next time round
274/// wants. tcc steps a pointer along a string with `lodsb` and `"=&S"` tied to `"0"`, and a read of
275/// the input would start the string again every time round.
276///
277/// And a read of a register an output alone is in is a read of that output, the same as a read of
278/// an output the template numbered. tcc copies a string with `lodsb` and `stosb` and `"=&a"` on an
279/// output nothing is tied to, and what `stosb` stores is what `lodsb` loaded one line up, which is
280/// the output as the template left it rather than anything the statement handed in.
281///
282/// `None` is a register the instruction uses and the statement put nothing in, which is the usual
283/// answer rather than an unusual one. `cpuid` writes four registers and a program that wanted one
284/// of them names one. See [`Lowering::spare`], which is where that one goes.
285fn bound(list: &[AsmOperand<'_>], reg: PhysReg, role: Role) -> Option<usize> {
286    let output =
287        list.iter().position(|operand| operand.result.is_some() && pinned(operand) == Some(reg));
288    if role.is_def() {
289        return output;
290    }
291    // The output first when something is in it on the way in, which is what `+` and a matching
292    // constraint both say, since its place is where a write earlier in the template left it and
293    // the read wants that. See [`read_as`] for what it holds before anything wrote it.
294    let arrives = |at: usize| read_as(list, at).is_some();
295    if let Some(at) = output.filter(|&at| arrives(at)) {
296        return Some(at);
297    }
298    let named = list.iter().position(|operand| {
299        operand.result.is_none() && operand.value.is_some() && pinned(operand) == Some(reg)
300    });
301    named.or(output)
302}
303
304/// The register one of an assembly statement's operands is in, whichever of the two ways said it.
305///
306/// A constraint letter is one way and is the only way a program can say one of the six registers
307/// that have a letter. A local register variable is the other, and it is the only way to say any
308/// of the rest: there is no letter for `r12`, which is the whole reason the extension exists, so
309/// the declaration says it and the front end wrote the name into the constraint. The name is read
310/// against this machine's table here, the same place the letter is read against it, and a name the
311/// machine has not got answers nothing, which leaves the operand where an operand nobody placed
312/// goes.
313///
314/// The sigil gcc allows in front of a name is taken off here, because what a name is written with
315/// is syntax and which register it means is this question.
316fn pinned(operand: &AsmOperand<'_>) -> Option<PhysReg> {
317    match operand.named {
318        Some(name) => {
319            let (reg, _) = x86_64::gpr_named(name.strip_prefix('%').unwrap_or(name))?;
320            Some(reg)
321        }
322        None => operand.fixed.and_then(x86_64::gpr_letter),
323    }
324}
325
326/// Whether a constraint says nothing but what it says on every machine.
327///
328/// [`AsmOperands::read`] gives the x86 meaning to every letter it knows, and most of the letters
329/// mean something else on AArch64: `Q` is an address in one register there rather than one of four
330/// registers, and `a` to `d` name nothing. So an AArch64 statement is taken only with the letters
331/// the two agree on, which are a register, a constant, memory, the immediate ranges and a matching
332/// number, and anything else is refused rather than read as x86. `w` and `Q` are the exceptions.
333/// `w` is a register on both, and which file it is in is decided by the caller with
334/// [`vector_letter`]. `Q` is read as `m` by the caller before the list is read. A
335/// register the front end named in braces is read against AArch64's own names, so what is inside
336/// them is not a letter.
337fn shared_letters(constraint: &str) -> bool {
338    let mut inside = false;
339    constraint.chars().all(|c| match c {
340        '{' => {
341            inside = true;
342            true
343        }
344        '}' => {
345            inside = false;
346            true
347        }
348        _ if inside => true,
349        _ => matches!(
350            c,
351            '=' | '+' | '&' | '%' | 'r' | 'w' | 'Q' | 'm' | 'o' | 'V' | 'g' | 'X' | 'i' | 'n'
352                | 'p' | 'I'..='N' | '0'..='9'
353        ),
354    })
355}
356
357/// A constraint list with every letter outside braces put through `swap`, and what is inside them,
358/// which is a register's name rather than letters, left alone.
359fn letters_outside(constraints: &str, swap: impl Fn(char) -> char) -> String {
360    let mut inside = false;
361    constraints
362        .chars()
363        .map(|c| {
364            match c {
365                '{' => inside = true,
366                '}' => inside = false,
367                _ if !inside => return swap(c),
368                _ => {}
369            }
370            c
371        })
372        .collect()
373}
374
375/// Whether an AArch64 constraint asks for a floating point or vector register, which is what `w`
376/// means there. A register named in braces is not a letter, so a `w` inside one is not read.
377fn vector_letter(constraint: &str) -> bool {
378    let mut inside = false;
379    constraint.chars().any(|c| {
380        match c {
381            '{' => inside = true,
382            '}' => inside = false,
383            _ => {}
384        }
385        !inside && c == 'w'
386    })
387}
388
389/// Whether a line of a template names, by number, an operand `wanted` says yes to.
390///
391/// `%%` is a percent sign rather than an operand, and a modifier letter may stand between the sign
392/// and the number.
393fn names_one(line: &str, wanted: impl Fn(usize) -> bool) -> bool {
394    let mut rest = line;
395    while let Some(at) = rest.find('%') {
396        let after = &rest[at + 1..];
397        if let Some(escaped) = after.strip_prefix('%') {
398            rest = escaped;
399            continue;
400        }
401        let after = after.strip_prefix(|c: char| c.is_ascii_alphabetic()).unwrap_or(after);
402        let digits = after.len() - after.trim_start_matches(|c: char| c.is_ascii_digit()).len();
403        if after[..digits].parse().is_ok_and(&wanted) {
404            return true;
405        }
406        rest = &after[digits..];
407    }
408    false
409}
410
411/// Why a function could not be lowered.
412///
413/// One reason and then nothing. A function with no rule for something in it is a function this
414/// cannot finish, and the second thing it could not lower is not news.
415#[derive(Debug, Clone, PartialEq, Eq)]
416pub enum Unsupported {
417    /// An instruction no rule fires on.
418    Inst {
419        /// The instruction that stopped it.
420        inst: Inst,
421        /// What the rule file would call it, or nothing if the rule language has no name for it
422        /// at all, which is what an instruction at a width nothing is written about looks like.
423        term: Option<&'static str>,
424        /// The opcode, which is what gets named when the rule language has no word for it.
425        ///
426        /// An opcode the rule language has no word for is exactly the opcode no rule lowers, so
427        /// without this the message would be empty in every case where somebody needs it.
428        opcode: Opcode,
429        /// What it produces, or nothing for an instruction that is only an effect.
430        ty: Option<Type>,
431    },
432    /// A parameter that does not arrive somewhere this can bring it in from.
433    ///
434    /// Not an instruction, which is why it is a separate arm: it is a fact about the signature
435    /// and there is nothing in the body of the function to point at.
436    Argument {
437        /// Its position in the signature.
438        index: usize,
439        /// What is wrong with where it arrives.
440        missing: Missing,
441    },
442    /// A call that passes or gives back a value this cannot put where the convention wants it.
443    Call {
444        /// The call.
445        inst: Inst,
446        /// Which value, and what is wrong with where it travels.
447        refused: Refused,
448    },
449    /// A `return` this cannot put where the convention wants it.
450    ///
451    /// A separate arm from [`Unsupported::Inst`] because it is not an instruction no rule fires
452    /// on. A return of more than one value is built from the convention rather than matched, the
453    /// same way a call is, so what goes wrong with one is what goes wrong with a call and not the
454    /// absence of a rule.
455    Returned {
456        /// The `return`.
457        inst: Inst,
458        /// What is wrong with where one of the values travels.
459        missing: Missing,
460    },
461    /// A stack slot the frame cannot give the bytes it asked for.
462    ///
463    /// Not an instruction no rule covers. An `alloca` is built here rather than matched, so what
464    /// goes wrong with one is what the frame can and cannot hold rather than what the rules spell.
465    Dynamic {
466        /// The `alloca`.
467        inst: Inst,
468        /// What the frame could not do about it.
469        growing: Growing,
470    },
471    /// More parameters of a type that travels on the x87 stack than the stack is deep.
472    ///
473    /// Not an instruction either, for the reason a function's parameter is not one: it is a fact
474    /// about the block and there is nothing in the block to point at. What crosses an edge for one
475    /// of these is the address of where the value is, and the block copies the bytes into a slot
476    /// of its own, all of them through the stack at once so that a block carrying two of them
477    /// swapped is copied in an order that is right. Eight is as many as the stack holds, and a
478    /// ninth would have to be copied before or after the rest, which is the order that could be
479    /// wrong.
480    Phi {
481        /// Which block it arrives at.
482        block: Block,
483        /// How many of them arrive there, which is the whole of what is wrong.
484        count: usize,
485        /// What they are.
486        ty: Type,
487    },
488    /// An `asm` statement this cannot build.
489    ///
490    /// Not an instruction no rule fires on, for the reason a call is not one: what it stands for is
491    /// whatever its template says, and no pattern over terms can read a string.
492    Assembly {
493        /// The `inline_asm`.
494        inst: Inst,
495        /// What about it is not built here yet.
496        refused: Written,
497    },
498    /// A `register long x asm ("...")` naming something this machine has not got.
499    ///
500    /// Not an instruction no rule fires on. There is a rule's worth of instruction here and what
501    /// is wrong is the string beside it, which is a name rather than a term, so the message says
502    /// the name. Which names a machine has is the machine's own question and this is where it is
503    /// asked, at the table a clobber list is read against.
504    Register {
505        /// The `register_value`.
506        inst: Inst,
507        /// The name the program wrote, as it wrote it.
508        name: String,
509    },
510    /// A naked function whose frame is not empty.
511    ///
512    /// Not an instruction no rule fires on, and there is nothing in the body to point at: the
513    /// function asked for no prologue and then wanted bytes only a prologue takes. Refused rather
514    /// than given the bytes anyway, because an offset into a frame nothing set up reaches into
515    /// whatever the caller left below its own stack pointer, which is wrong code that assembles.
516    /// See [`crate::frame::Layout::naked`].
517    Naked {
518        /// How many bytes it wanted, which is the whole of what is wrong.
519        bytes: u32,
520    },
521    /// Something the x86-64 lowering writes by hand and nothing has written for this machine yet.
522    ///
523    /// Refused rather than written with the x86 instructions, which is what the walk would do
524    /// otherwise, since these are the places it names them itself.
525    Unported {
526        /// The instruction, or nothing for the one that is about a signature.
527        inst: Option<Inst>,
528        /// Which of them.
529        what: Unported,
530    },
531}
532
533/// What [`Unsupported::Unported`] is about.
534#[derive(Debug, Clone, Copy, PartialEq, Eq)]
535pub enum Unported {
536    /// The thread pointer on Apple's platforms, which keep it somewhere other than Linux does.
537    Thread,
538}
539
540impl Unported {
541    /// The whole message, since there is nothing to put in front of it.
542    #[must_use]
543    pub fn why(self) -> &'static str {
544        match self {
545            Unported::Thread => "the thread pointer is not written for this platform yet",
546        }
547    }
548}
549
550/// What about an `asm` statement is not built yet.
551#[derive(Debug, Clone, Copy, PartialEq, Eq)]
552pub enum Written {
553    /// A template with instructions in it.
554    Template,
555    /// An `asm goto`, whose labels make the statement a terminator.
556    Goto,
557    /// An operand this cannot put where the constraint says it goes.
558    Operand,
559    /// A clobber list naming something this has no register for.
560    Clobber,
561    /// A `jmp` out of the function in a function that has an epilogue behind it.
562    Away,
563}
564
565impl Written {
566    /// The rest of the sentence that starts with the statement.
567    #[must_use]
568    pub fn why(self) -> &'static str {
569        match self {
570            // The template is the assembler's to read and there is no assembler here yet, so a
571            // template with anything in it is a string nothing can turn into bytes. An empty one is
572            // no instructions, and no instructions is something this can write.
573            Written::Template => "has instructions in its template, which nothing here assembles",
574            Written::Goto => "jumps to a label, which nothing here builds an edge for",
575            Written::Operand => "has an operand this cannot place",
576            Written::Clobber => "says it destroys a register this has no name for",
577            Written::Away => {
578                "jumps out of the function, which only a function that is `naked` may do, since \
579                 anywhere else there is an epilogue behind it to give the frame back"
580            }
581        }
582    }
583}
584
585/// What the frame could not do about a stack slot.
586#[derive(Debug, Clone, Copy, PartialEq, Eq)]
587pub enum Growing {
588    /// An object of a size the number a frame counts bytes in does not reach.
589    Huge,
590    /// A variable length array wanting more alignment than a call leaves the stack pointer with.
591    ///
592    /// Rounding the stack pointer down again after the bytes have been taken would put it
593    /// somewhere no constant reaches the rest of the frame from, so a frame like this needs a
594    /// second base register held for the whole of the function. Nothing here holds one.
595    ///
596    /// [`crate::expand::rounds`] takes the array away before this sees it, by asking for the
597    /// alignment in extra bytes and handing out an address inside them, so what is left of this
598    /// is IR that arrived without going through that pass and the fixed local in
599    /// [`crate::pipeline`] that wants the same thing from the other side.
600    Aligned,
601    /// A variable length array in a function written without a prologue.
602    ///
603    /// A frame that grows is reached from a frame pointer, and establishing one is the first two
604    /// instructions of a prologue that `__attribute__((naked))` asked there be none of. See
605    /// [`crate::frame::Layout::naked`].
606    Naked,
607}
608
609impl Growing {
610    /// The rest of the sentence that starts with the slot.
611    #[must_use]
612    pub fn why(self) -> &'static str {
613        match self {
614            Growing::Huge => "is more bytes than a frame counts",
615            Growing::Aligned => {
616                "wants more alignment than the stack pointer is left on, which needs a base \
617                 register nothing here keeps"
618            }
619            Growing::Naked => {
620                "is in a function that is `naked`, which has no prologue to point a frame pointer \
621                 at it with"
622            }
623        }
624    }
625}
626
627impl Unsupported {
628    /// The instruction it is about, or nothing for the one arm that is about a signature.
629    ///
630    /// What a caller wants this for is the span. The function knows where every instruction in
631    /// it came from, so a caller holding both can point a message at the line somebody wrote
632    /// rather than at the file as a whole, and nothing here has to carry a span of its own.
633    pub fn inst(&self) -> Option<Inst> {
634        match *self {
635            Unsupported::Inst { inst, .. }
636            | Unsupported::Call { inst, .. }
637            | Unsupported::Returned { inst, .. }
638            | Unsupported::Dynamic { inst, .. }
639            | Unsupported::Assembly { inst, .. }
640            | Unsupported::Register { inst, .. } => Some(inst),
641            Unsupported::Unported { inst, .. } => inst,
642            Unsupported::Argument { .. } | Unsupported::Phi { .. } | Unsupported::Naked { .. } => {
643                None
644            }
645        }
646    }
647}
648
649impl fmt::Display for Unsupported {
650    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
651        match *self {
652            Unsupported::Inst { term: Some(term), .. } => write!(f, "no rule lowers `{term}`"),
653            Unsupported::Inst { term: None, opcode, ty: Some(ty), .. } => {
654                write!(f, "no rule lowers a `{opcode}` producing a `{ty}`")
655            }
656            Unsupported::Inst { term: None, opcode, ty: None, .. } => {
657                write!(f, "no rule lowers a `{opcode}`")
658            }
659            Unsupported::Argument { index, missing } => {
660                write!(f, "parameter {index} {}", missing.why())
661            }
662            Unsupported::Call { refused: Refused { argument: Some(index), missing }, .. } => {
663                write!(f, "argument {index} of this call {}", missing.why())
664            }
665            Unsupported::Call { refused: Refused { argument: None, missing }, .. } => {
666                write!(f, "what this call gives back {}", missing.why())
667            }
668            Unsupported::Returned { missing, .. } => {
669                write!(f, "what this function gives back {}", missing.why())
670            }
671            Unsupported::Dynamic { growing, .. } => {
672                write!(f, "this local {}", growing.why())
673            }
674            Unsupported::Phi { block, count, ty } => {
675                let block = block.index();
676                write!(
677                    f,
678                    "block{block} takes {count} parameters of type `{ty}` and only {X87_DEPTH} can cross an edge at once"
679                )
680            }
681            Unsupported::Assembly { refused, .. } => write!(f, "this `asm` {}", refused.why()),
682            Unsupported::Unported { what, .. } => f.write_str(what.why()),
683            Unsupported::Register { ref name, .. } => {
684                write!(
685                    f,
686                    "this object is kept in `{name}`, which is not a register this machine has"
687                )
688            }
689            Unsupported::Naked { bytes } => write!(
690                f,
691                "this function is `naked` and wants {bytes} bytes of frame, which there is no prologue to take"
692            ),
693        }
694    }
695}
696
697impl std::error::Error for Unsupported {}
698
699/// A lowered function, and what the frame needs that the machine IR does not hold.
700#[derive(Debug)]
701pub struct Lowered {
702    /// The function, in machine instructions.
703    pub func: mir::Func,
704    /// What it wants its stack to look like, which is separate from the function so that the two
705    /// can be read and written at the same time.
706    pub stack: Stack,
707    /// Which rules of the table lowered it, which is what `-Zrule-coverage` asks for and what
708    /// `crate::coverage` writes down.
709    pub fired: Fired,
710    /// Which machine IR block each IR block became, indexed by the IR block's own index, and
711    /// nothing for a block the walk never reached.
712    ///
713    /// Here because it is the only place the correspondence exists. Selection makes one block per
714    /// block, in the same order and with the arms in the same order, so anything the IR knows
715    /// about a block can be carried down through this and nothing else, and
716    /// [`crate::weights::carry`] is what does.
717    pub blocks: Vec<Option<mir::Block>>,
718}
719
720/// What a function's stack has to hold, as far as selection is able to say.
721///
722/// All of it is answered here because selection is where a call is built and where an `alloca`
723/// is read, and nothing after it could tell what either of them needed.
724#[derive(Debug, Default)]
725pub struct Stack {
726    /// How many bytes the widest call in the function needs below the stack pointer for the
727    /// arguments it passes there, or `None` for a function that makes no call at all.
728    ///
729    /// `None` is a leaf, which is the function that may use the red zone and the one whose stack
730    /// pointer does not have to be left aligned for anybody.
731    pub calls: Option<u32>,
732    /// The memory the function asked for itself, one entry for every `alloca` in it, in the order
733    /// the walk reached them.
734    pub locals: Vec<Local>,
735    /// Which instruction computes the address of which of those locals.
736    ///
737    /// An address in the frame is a distance from the stack pointer, and there is no frame until
738    /// after allocation, so the instruction is written here with nothing in its displacement and
739    /// [`crate::finish`] writes the number in once [`crate::frame::Frame`] knows it.
740    pub addresses: Vec<(mir::Inst, usize)>,
741    /// Which of those locals is which declaration in the source, for the ones the program declared.
742    ///
743    /// The number is the one the IR function carries and means nothing here. What it is for is the
744    /// debugging information, which has to say where a named local ended up and cannot ask the
745    /// frame directly: the frame knows a local by the order the `alloca` for it was lowered in and
746    /// by nothing else.
747    ///
748    /// Shorter than the list above rather than the same length, because most of what a function
749    /// keeps in its frame is memory an expression wanted somewhere to put.
750    pub declared: Vec<(usize, u32)>,
751    /// Which instruction computes the address of a piece of memory whose size the function works
752    /// out while it runs, which is what a variable length array is.
753    ///
754    /// Waiting on [`crate::finish`] for a different number from the one the addresses above are:
755    /// the bytes were taken off the stack pointer by the instruction in front of this one, so where
756    /// they start is however much of the bottom of the frame belongs to the arguments of a call,
757    /// and that is not known until the frame is.
758    pub dynamic: Vec<mir::Inst>,
759    /// Which instruction takes those bytes off the stack pointer, one for every one of them, in the
760    /// order the walk reached them.
761    ///
762    /// Read by [`crate::finish`] on a command line that asked for the stack to be touched a page at
763    /// a time, which is the one thing that has to find these again: the bytes are in a register by
764    /// then, so the walk down to them is a loop, and a loop is written around an instruction rather
765    /// than in front of a block. Nothing else looks at them, because everything else about a frame
766    /// that grows is answered by the address the instruction below this one computes.
767    pub grown: Vec<mir::Inst>,
768    /// Where the function first moves the stack pointer while it runs, if it does at all.
769    ///
770    /// Two things are read off this. One is whether at all, which is what [`crate::frame::Layout`]
771    /// wants, because a frame that moves its stack pointer has a different shape from one that does
772    /// not and the layout is built before the instructions are looked at again. See `Growing` in
773    /// [`crate::frame`]. The other is where, so that a caller that cannot accept such a frame has
774    /// somewhere to point when it says so.
775    pub grown_at: Option<Inst>,
776    /// Which instruction reads which of the arguments the caller passed on the stack, as how far up
777    /// the caller's argument area it reads.
778    ///
779    /// Waiting on [`crate::finish`] for the same reason the addresses above are, and on one thing
780    /// more: where the caller's argument area is from inside this function depends on whether the
781    /// prologue had to force the stack pointer's alignment, so which register the load reads
782    /// through is not settled here either.
783    pub arguments: Vec<(mir::Inst, u32)>,
784    /// Whether the function asked where its own frame is, which is what `__builtin_frame_address`
785    /// and `__builtin_return_address` both start from.
786    ///
787    /// A function like that keeps a frame pointer whatever the flags say, because the register is
788    /// the answer to the first of them and the start of the walk for every depth above zero. There
789    /// is no other way to reach it: the distance from the stack pointer to the frame is a number
790    /// the layout works out, and what a walk up the chain needs is the link the prologue saved.
791    pub walks_frames: bool,
792    /// Whether the function saved a place for a `__builtin_longjmp` to come back to, which is what
793    /// `__builtin_setjmp` does.
794    ///
795    /// A function like that keeps a frame pointer whatever the flags say as well, and for a reason
796    /// of the same shape: the two registers the restore puts back are the frame pointer and the
797    /// stack pointer, and a frame that did not keep the first of them has nothing in it saying
798    /// where the caller's frame is for the epilogue to find after control has come back.
799    pub saves_place: bool,
800    /// The calls a `tail_call` became that [`crate::tail::jumps`] may turn into a jump, which is
801    /// the ones that passed everything in registers.
802    pub tails: Vec<crate::tail::Tail>,
803}
804
805impl Stack {
806    /// The layout given, with the three fields only the lowering knows the answer to filled in.
807    ///
808    /// Everything else in a layout comes from the flags the function is compiled under or from the
809    /// allocation, so this takes one and returns it rather than building one.
810    ///
811    /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
812    /// zone, which is the words below the stack pointer nothing else may write, and a function
813    /// control comes back into from a `__builtin_longjmp` has already had something else running
814    /// down there: whatever it called and whatever that called, or a signal handler on the same
815    /// stack. Every one of those has written over the red zone by the time control arrives, so a
816    /// value this function left there would not be there any more.
817    #[must_use]
818    pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
819        Layout {
820            leaf: self.calls.is_none() && !self.saves_place,
821            outgoing: self.calls.unwrap_or(0),
822            locals: &self.locals,
823            grows: self.grown_at.is_some(),
824            ..base
825        }
826    }
827}
828
829/// The machine IR for that function, for the machine the selector describes.
830///
831/// # Errors
832///
833/// The first instruction no rule fires on, which today is anything at a width the rule set is not
834/// written at, a parameter that does not arrive in a register this can read, or a call that
835/// passes something this cannot put where the convention wants it.
836pub fn func(
837    source: &Func,
838    names: &mut Interner,
839    selector: &'static Selector,
840    conv: &'static CallRegs,
841    elsewhere: &Elsewhere,
842) -> Result<Lowered, Unsupported> {
843    Lowering::new(source, names, selector, conv, elsewhere).run()
844}
845
846/// What the matcher settled on for one block, indexed the way the block's instructions are.
847struct Decided {
848    /// What each instruction matched, and nothing for one that matched no rule or was folded
849    /// into a later one.
850    found: Vec<Option<Match<Term>>>,
851    /// How each instruction showed its operands to the matcher, which is what says what it took.
852    plans: Vec<Option<Plan>>,
853    /// The instructions some other instruction took, which are the ones with nothing to write.
854    folded: Vec<Inst>,
855}
856
857/// The instruction in front of an assignment that starts a declaration on a value, and the first
858/// machine instruction after it once the block is filled.
859type Mark = (Option<Inst>, Option<mir::Inst>);
860
861/// One function being lowered.
862struct Lowering<'a> {
863    source: &'a Func,
864    names: &'a mut Interner,
865    out: mir::Func,
866    /// The machine register each IR value is in, once it has one.
867    regs: Vec<Option<mir::Reg>>,
868    /// For a constant that has been written into a register, the block it was written into,
869    /// which is the only block that register is any good in.
870    written: Vec<Option<mir::Block>>,
871    /// How many times each IR value is read, which is what says whether an instruction may be
872    /// folded into the one that reads it.
873    uses: Vec<u32>,
874    /// The block being filled.
875    at: Option<mir::Block>,
876    /// The machine IR block each IR block became.
877    blocks: Vec<Option<mir::Block>>,
878    /// The class an address is in, which is the general purpose one and is not a question: every
879    /// register an addressing mode names holds part of an address, and there is no machine here
880    /// that computes an address anywhere but in this file. Which class a *value* is in is
881    /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
882    gpr: RegClass,
883    /// The machine this selects for.
884    selector: &'static Selector,
885    /// Where the convention this function is compiled for puts things, which is read for the
886    /// arguments and for the calls.
887    conv: &'static CallRegs,
888    /// Which names this function may not work an address out for itself, which is a fact about the
889    /// module and so is worked out before any of this and handed in.
890    elsewhere: &'a Elsewhere,
891    /// What the function wants its stack to look like, filled in as the walk finds out.
892    stack: Stack,
893    /// What a `va_start` in this function has to write, or nothing for a function that takes no
894    /// arguments its signature does not name.
895    ///
896    /// Worked out once, when the entry block binds the parameters, because every number in it is
897    /// about where those parameters left the walk over the argument registers and there is nowhere
898    /// else that knows.
899    varargs: Option<Varargs>,
900    /// Which of the function's stack objects each eighty bit value lives in, once it has asked
901    /// for one.
902    ///
903    /// One slot per value and it is never given back, which is what makes an eighty bit value
904    /// behave like every other one: it is written once and read wherever it is read, and no two
905    /// of them share a slot the way two of them would share a register. What is in a register is
906    /// the address, and that is worked out again at every use rather than kept, so nothing here
907    /// holds a general purpose register open across a whole function.
908    slots: Vec<Option<usize>>,
909    /// The eight bytes a value passes through between a register and the x87 stack, once
910    /// something has wanted them.
911    ///
912    /// One for the whole function, because every group that uses it is a handful of instructions
913    /// with nothing in between: the bytes are written, read straight back and never looked at
914    /// again, so a second slot would be a second slot holding the same nothing.
915    crossing: Option<usize>,
916    /// The four bytes the control word is saved in and the changed copy written to, once
917    /// something has wanted them.
918    ///
919    /// One for the whole function for the reason above, and four rather than two because it is
920    /// two words: the one the unit had and the one with the rounding field turned to truncate.
921    control: Option<usize>,
922    /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
923    ///
924    /// One for the whole function however many saves there are in it, because the word is written
925    /// and read back with nothing in between: the save writes a zero into it and the instruction
926    /// straight after reads it, and the only other thing that ever writes it is a restore arriving
927    /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
928    /// inside the other.
929    answer: Option<usize>,
930    /// The block `__builtin_apply_args` answers the address of, or nothing in a function that holds
931    /// none.
932    ///
933    /// Written once, in the prologue, because what it holds is every argument register as it was
934    /// on the way in, and by the time the walk reaches the call the registers hold whatever the
935    /// function has done since. Every `__builtin_apply_args` in the function answers the same one.
936    applied: Option<usize>,
937    /// Which rules have fired so far.
938    fired: Fired,
939    /// Where each assignment that starts a declaration on a value part of the way through is, by
940    /// the IR block it is in and the instruction in front of it, and which machine instruction
941    /// is the first one after it once the block has been filled. See
942    /// [`rucc_ir::Func::declare_value_from`].
943    marks: HashMap<Block, Vec<Mark>>,
944}
945
946/// What a `va_start` in a variadic function writes into the list it is given.
947///
948/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
949/// both are written down. Neither is a set of numbers on its own: where the save area is and where
950/// the caller's argument area is are distances into a frame that does not exist until after
951/// allocation, so each is a `lea` [`crate::finish`] fills in.
952#[derive(Debug, Clone, Copy, PartialEq, Eq)]
953enum Varargs {
954    /// The four field list, whose two offsets are settled here and whose two addresses are not.
955    Fields {
956        /// Which of the function's stack objects is the register save area.
957        save: usize,
958        /// How far up the caller's argument area the first argument the signature does not name is,
959        /// which is the whole of that area the named ones did not take.
960        incoming: u32,
961        /// What `gp_offset` starts at, which is past the general purpose registers the named
962        /// arguments took.
963        integers: u32,
964        /// What `fp_offset` starts at, which is past the vector ones.
965        floats: u32,
966    },
967    /// The AAPCS64 list, whose two offsets count up to zero from the top of each half of the save
968    /// area. The two tops are addresses in the frame and so is the first field, like the SysV list.
969    Aapcs {
970        /// Which of the function's stack objects is the register save area.
971        save: usize,
972        /// How far up the caller's argument area the first argument the signature does not name is.
973        incoming: u32,
974        /// Where the general purpose half of the save area ends.
975        integers_end: u32,
976        /// Where the vector half ends, which is the end of the area.
977        floats_end: u32,
978        /// What `__gr_offs` starts at, which is minus the general purpose half the named arguments
979        /// did not take.
980        integers: i32,
981        /// What `__vr_offs` starts at.
982        floats: i32,
983    },
984    /// The list that is a pointer, which is the one address and nothing else.
985    Pointer {
986        /// How far up the caller's argument area the first argument the signature does not name is,
987        /// which on this convention is the word belonging to the position the named ones stopped
988        /// at.
989        incoming: u32,
990    },
991}
992
993/// How far a function's name reaches, narrowed from the linkage the IR gave it.
994///
995/// The IR has five and an object file says three, and the two the linker cannot tell apart are
996/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
997/// no way to record. A function is never `Common`, since that is what a tentative definition of an
998/// object is and there is no tentative definition of a function, and it is written here rather
999/// than left out so that a linkage added later has to come past this.
1000const fn binding(linkage: Linkage) -> mir::Binding {
1001    match linkage {
1002        Linkage::Internal => mir::Binding::Local,
1003        Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
1004        Linkage::External | Linkage::Common => mir::Binding::Global,
1005    }
1006}
1007
1008/// How far a function's name reaches outside a shared library, carried across unchanged.
1009///
1010/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
1011/// three of these and the two enumerations are the same three answers written twice: once in a
1012/// crate that is not allowed to know what an object file is and once in one that is.
1013const fn visibility(visibility: Visibility) -> mir::Visibility {
1014    match visibility {
1015        Visibility::Default => mir::Visibility::Default,
1016        Visibility::Hidden => mir::Visibility::Hidden,
1017        Visibility::Protected => mir::Visibility::Protected,
1018    }
1019}
1020
1021impl<'a> Lowering<'a> {
1022    fn new(
1023        source: &'a Func,
1024        names: &'a mut Interner,
1025        selector: &'static Selector,
1026        conv: &'static CallRegs,
1027        elsewhere: &'a Elsewhere,
1028    ) -> Self {
1029        let counts = source.counts();
1030        let name = source.name;
1031        let mut uses = vec![0; counts.values];
1032        for block in source.blocks() {
1033            for inst in source.insts(block) {
1034                for &arg in &source[source[inst].args] {
1035                    uses[arg.index()] += 1;
1036                }
1037                for call in source.successors(inst) {
1038                    for &arg in &source[call.args] {
1039                        uses[arg.index()] += 1;
1040                    }
1041                }
1042            }
1043        }
1044        let mut out = mir::Func::new(name);
1045        out.align = source.align;
1046        // Carried rather than worked out here, because where a function was declared is a fact
1047        // about the source and this is a long way past it. What wants it is the line table.
1048        out.declared = source.declared;
1049        out.binding = binding(source.linkage);
1050        out.visibility = visibility(source.visibility);
1051        Self {
1052            source,
1053            names,
1054            out,
1055            regs: vec![None; counts.values],
1056            written: vec![None; counts.values],
1057            blocks: vec![None; counts.blocks],
1058            uses,
1059            at: None,
1060            gpr: selector.gpr,
1061            selector,
1062            conv,
1063            elsewhere,
1064            stack: Stack::default(),
1065            varargs: None,
1066            slots: vec![None; counts.values],
1067            crossing: None,
1068            control: None,
1069            answer: None,
1070            applied: None,
1071            fired: Fired::new(),
1072            marks: HashMap::new(),
1073        }
1074    }
1075
1076    fn run(mut self) -> Result<Lowered, Unsupported> {
1077        for value in self.source.values() {
1078            for start in self.source.value_starts(value) {
1079                let Some((block, after)) = self.source.start_place(start) else { continue };
1080                let marks = self.marks.entry(block).or_default();
1081                if !marks.iter().any(|&(have, _)| have == after) {
1082                    marks.push((after, None));
1083                }
1084            }
1085        }
1086        // Every block before any of them is filled, because a block that jumps forward has to
1087        // name the block it jumps to and a machine IR block is named by a handle rather than by
1088        // the IR block it came from.
1089        for block in self.source.blocks() {
1090            let out = self.out.create_block();
1091            self.blocks[block.index()] = Some(out);
1092        }
1093        for block in self.order() {
1094            self.block(block)?;
1095        }
1096        // And the name each block an image holds the address of was given, which nothing in the
1097        // walk above would ask for: the `lea` a label address is inside the function needs no
1098        // symbol, and the one thing that does is a relocation in another section.
1099        let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
1100        let labels: Vec<(mir::Block, Symbol)> =
1101            named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
1102        self.out.labels = labels;
1103        self.naming();
1104        Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
1105    }
1106
1107    /// Which register each declaration the front end kept in a value ended up in, as far as this
1108    /// walk can say, which is the other half of what [`Lowering::new_reg`] writes down as it goes.
1109    ///
1110    /// Two halves because there are two ways a value gets a register here. Most of them ask for a
1111    /// fresh one and that is where `new_reg` catches them, and the rest are put in a register
1112    /// something else chose: a parameter arrives in whichever one the convention handed it, a block
1113    /// parameter in whichever one the edge agreed on, and a result of a rule that names its own
1114    /// registers in the one the rule named. None of those goes past the mint, so this is the map at
1115    /// the end read off the other side, and the two together are every value a declaration is
1116    /// behind.
1117    ///
1118    /// The map on its own would not do, which is why `new_reg` writes down what it writes down: the
1119    /// entry for a constant is cleared every time the walk leaves the block that wrote it, so a
1120    /// local a constant holds is in the map for one block of the function and nowhere else.
1121    fn naming(&mut self) {
1122        let mut named = std::mem::take(&mut self.out.named);
1123        for value in self.source.values() {
1124            let Some(reg) = self.regs[value.index()] else { continue };
1125            named.extend(self.source.value_decls(value).map(|decl| (decl, reg)));
1126            // A start in a block a pass took out was never reached above, and it says nothing
1127            // rather than something about another place.
1128            for start in self.source.value_starts(value) {
1129                let Some((block, after)) = self.source.start_place(start) else { continue };
1130                let first = self.marks.get(&block).and_then(|marks| {
1131                    marks.iter().find(|&&(have, _)| have == after).and_then(|&(_, at)| at)
1132                });
1133                if let Some(first) = first {
1134                    self.out.starts.push((start.decl, reg, first));
1135                }
1136            }
1137        }
1138        named.sort_unstable();
1139        named.dedup();
1140        self.out.named = named;
1141        self.out.starts.sort_unstable();
1142        self.out.starts.dedup();
1143        // Which of its values a declaration holds on the way into a block, for the blocks where
1144        // two of them are live at once. A block a pass took out says nothing, and neither does a
1145        // value the map above has lost the register of, since that is not the same as having none.
1146        let mut entries = Vec::new();
1147        for (decl, block, value) in crate::holding::on_entry(self.source) {
1148            if let (Some(block), Some(reg)) = (self.blocks[block.index()], self.regs[value.index()])
1149            {
1150                entries.push((decl, block, reg));
1151            }
1152        }
1153        entries.sort_unstable();
1154        entries.dedup();
1155        self.out.entries = entries;
1156    }
1157
1158    /// The order the blocks are filled in, which is not the order they are written in.
1159    ///
1160    /// Reverse postorder, because a value is written in a block that dominates every block that
1161    /// reads it and a block in reverse postorder comes before every block it dominates. The order
1162    /// the blocks are written in does not have that property: a block written early can read a
1163    /// value a block below it writes, and reading a value with no register yet mints one, so the
1164    /// register the definition writes later is not the register the read named. Nothing writes the
1165    /// one the read named, and what comes out is a function that loads a stack slot no store ever
1166    /// reached. It is the order this walk goes in rather than the order the blocks come out in,
1167    /// which is what the loop above fixes, so the machine function is still written the way the IR
1168    /// function was.
1169    ///
1170    /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
1171    /// them and nothing they name is read by anything that does, but they still have to be filled,
1172    /// because a machine block with no terminator is not one the passes below can read.
1173    fn order(&self) -> Vec<Block> {
1174        let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
1175        let count = self.blocks.len();
1176        let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
1177        for block in self.source.blocks() {
1178            let Some(term) = self.source.terminator(block) else { continue };
1179            succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
1180        }
1181        // An explicit stack, because the depth of the walk is the number of blocks and a function
1182        // built by a generator has as many of those as it likes.
1183        let mut seen = vec![false; count];
1184        let mut order = Vec::with_capacity(count);
1185        let mut stack = vec![(entry, 0usize)];
1186        seen[entry.index()] = true;
1187        while let Some((block, at)) = stack.pop() {
1188            let Some(&next) = succs[block.index()].get(at) else {
1189                order.push(block);
1190                continue;
1191            };
1192            stack.push((block, at + 1));
1193            if !seen[next.index()] {
1194                seen[next.index()] = true;
1195                stack.push((next, 0));
1196            }
1197        }
1198        order.reverse();
1199        order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
1200        order
1201    }
1202
1203    /// One block: its parameters, then every instruction in it that is not folded into another.
1204    fn block(&mut self, block: Block) -> Result<(), Unsupported> {
1205        let out = self.out_block(block);
1206        self.at = Some(out);
1207        if self.source.entry() == Some(block) {
1208            self.arrive(block, out)?;
1209        } else {
1210            let mut arriving = Vec::new();
1211            for &param in &self.source[block].params {
1212                // A value with no register to arrive in, which the class would not say, since
1213                // `class_of` puts one of these in the general purpose file on purpose and what it
1214                // means by that is that nothing there can hold it. What crosses the edge for one
1215                // of those is the address of where the value already is, so the parameter is a
1216                // pointer here and the bytes it points at are copied below.
1217                let ty = self.source[param].ty;
1218                let reg = self.out.append_param(out, self.class_of(ty));
1219                self.regs[param.index()] = Some(reg);
1220                if on_x87(ty) {
1221                    arriving.push((param, reg));
1222                }
1223            }
1224            self.settle(block, &arriving)?;
1225        }
1226
1227        // What each instruction matched, and which instructions were folded into another. The
1228        // decision is made for the whole block before any of it is written, and it is made more
1229        // than once: a value that only some of its readers took has to be put back in a register
1230        // for all of them, and taking it away from those readers changes what they match.
1231        let insts: Vec<Inst> = self.source.insts(block).collect();
1232        let mut refused: HashSet<Value> = HashSet::new();
1233        let mut decided = self.decide(&insts, &refused);
1234        while let Some(value) = self.left_alive(&insts, &decided.plans) {
1235            refused.insert(value);
1236            decided = self.decide(&insts, &refused);
1237        }
1238        let Decided { found, folded, .. } = decided;
1239
1240        // Where each assignment in this block that starts a declaration on a value is, as the
1241        // machine instruction in front of the place its IR instruction left off, or the block
1242        // for one where nothing has been written yet. What comes after it is not known until the
1243        // block is filled, so that is read below.
1244        let wanted: HashSet<Option<Inst>> =
1245            self.marks.get(&block).into_iter().flatten().map(|&(after, _)| after).collect();
1246        let mut reached: Vec<(Option<Inst>, mir::Block, Option<mir::Inst>)> = Vec::new();
1247        for (index, (&inst, matched)) in insts.iter().zip(found).enumerate() {
1248            let before = index.checked_sub(1).map(|index| insts[index]);
1249            if wanted.contains(&before) {
1250                let at = self.at.unwrap_or(out);
1251                reached.push((before, at, self.out.terminator(at)));
1252            }
1253            if folded.contains(&inst) || self.writes_nothing(inst) {
1254                continue;
1255            }
1256            // A call is built from the convention rather than matched, which is why it is the one
1257            // opcode looked at by name here. Through an address it is a different instruction and
1258            // the same convention, so the two arrive at the same place and differ in one line of
1259            // it.
1260            match self.source[inst].opcode {
1261                Opcode::Call | Opcode::CallIndirect => {
1262                    self.called(inst)?;
1263                    continue;
1264                }
1265                // A call and the return behind it, which is what `crate::tail::mark` made it out
1266                // of, and both are built the way they would have been. What makes it a jump is
1267                // written at the very end, once the epilogue is there to jump from.
1268                Opcode::TailCall => {
1269                    self.tail_called(inst)?;
1270                    continue;
1271                }
1272                // Built from the frame rather than matched, for the same shape of reason a call
1273                // is built from the convention: what a rule replaces a term with is instructions,
1274                // and what an `alloca` needs first is bytes, which the rule language has no way
1275                // to ask for.
1276                Opcode::Alloca => {
1277                    self.reserve(inst)?;
1278                    continue;
1279                }
1280                // Reading the stack pointer and writing it back, which are the two ends of a scope
1281                // holding a variable length array. Built here for the reason an `alloca` is: the
1282                // value is a register the rule language has no way to name, because what it holds
1283                // is not a value the program computed but where the machine's stack had got to.
1284                // The arguments the function was handed, saved in the prologue, and a call made
1285                // out of them. Built here because neither is a value a rule could say anything
1286                // about: the first is a place in the frame and the second is a call, whose
1287                // arguments are a block of registers rather than values.
1288                Opcode::ApplyArgs => {
1289                    self.apply_args(inst)?;
1290                    continue;
1291                }
1292                Opcode::Apply => {
1293                    self.apply(inst)?;
1294                    continue;
1295                }
1296                Opcode::StackSave => {
1297                    self.stack_pointer(inst, false)?;
1298                    continue;
1299                }
1300                Opcode::StackRestore => {
1301                    self.stack_pointer(inst, true)?;
1302                    continue;
1303                }
1304                // The address of a name, built here for the same reason an `alloca` is: what a
1305                // rule replaces a term with is instructions over values, and the operand of this
1306                // one is a symbol, which is a thing the rule language has no way to bind and the
1307                // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
1308                // proof over bitvectors could discharge, because what makes it the right answer
1309                // is the relocation and what the linker does with it.
1310                Opcode::GlobalAddr => {
1311                    self.address_of(inst)?;
1312                    continue;
1313                }
1314                // The address of a label and the branch that reads one, built here for the same
1315                // reason and for one more. The reason is the same: what the first of them names is
1316                // a block, which is not a value a rule pattern can bind, and there is nothing in
1317                // the distance between two places in one function that a proof over bitvectors
1318                // could discharge. The extra one is that the second is a terminator whose arms are
1319                // not two and not fixed, and a rule says what an instruction reads rather than
1320                // where a block goes.
1321                Opcode::BlockAddr => {
1322                    self.block_address(inst)?;
1323                    continue;
1324                }
1325                Opcode::IndirectBr => {
1326                    self.indirect_branch(inst)?;
1327                    continue;
1328                }
1329                // A `switch` that `crate::switch` found dense enough for a table, which is a load
1330                // out of the table and the same jump. Built here for the reasons the jump above
1331                // is, and because what the load reads is a place in this function.
1332                Opcode::Switch => {
1333                    self.jump_table(inst)?;
1334                    continue;
1335                }
1336                // The pair that saves a place in this function and comes back to it. Built here
1337                // for the reason the address of a label is, and for two more. The reason is the
1338                // same: the first of them writes down where control comes back to, which is a
1339                // place in this function and not a value a rule pattern can bind. The extra ones
1340                // are that each of them is a group of instructions over a buffer the program owns
1341                // rather than one instruction, and that the first of them leaves the block it was
1342                // written in and carries on in a new one, which is a thing no rule can do.
1343                Opcode::SetjmpMarker => {
1344                    self.saves_place(inst)?;
1345                    continue;
1346                }
1347                Opcode::LongjmpMarker => {
1348                    self.comes_back(inst)?;
1349                    continue;
1350                }
1351                // Where this thread's own storage starts, built here for a reason of the same
1352                // shape: what it reads is `%fs`, which is not a register the rule language can
1353                // bind and not one a proof over bitvectors could say anything about, because what
1354                // makes the load the right answer is an agreement between the loader and the C
1355                // library rather than any arithmetic.
1356                Opcode::ThreadPointer => {
1357                    self.thread_pointer(inst)?;
1358                    continue;
1359                }
1360                // What a named machine register holds, built here for the reason above written
1361                // about any register rather than about one: which register it is is a string
1362                // beside the instruction, and a rule matches on an opcode and a type and could
1363                // not see it. There is nothing to prove either, since the answer is the register
1364                // and the instruction is the move that reads it.
1365                Opcode::RegisterValue => {
1366                    self.register_value(inst)?;
1367                    continue;
1368                }
1369                // Where a frame is and what it returns to, built here for the same reason and one
1370                // more. The reason is the same: what the walk starts from is the frame pointer,
1371                // which is not a register a rule pattern can bind, and there is nothing in reading
1372                // the link the prologue saved that a proof over bitvectors could discharge. The
1373                // extra one is that how long the walk is comes out of a number beside the
1374                // instruction, so one of these is not one instruction but however many the depth
1375                // says, and a rule replaces a term with a term.
1376                Opcode::FrameAddress | Opcode::ReturnAddress => {
1377                    self.frames(inst)?;
1378                    continue;
1379                }
1380                // Built from the frame for the reason an `alloca` is, and from the convention for
1381                // the reason a call is: three of the four fields it writes are distances that do
1382                // not exist until the frame does, and the fourth is where the walk over the
1383                // argument registers stopped. A function that is not variadic has no such walk to
1384                // report, so it has nothing here and is refused below, which is the right answer
1385                // for a `va_start` in one.
1386                Opcode::VaStart if self.varargs.is_some() => {
1387                    self.va_start(inst)?;
1388                    continue;
1389                }
1390                // A return of more than one value, which is a structure small enough to come
1391                // back in a pair of registers. Built from the convention for the reason a call
1392                // is: which register each half goes in depends on the halves in front of it,
1393                // because the two register files are walked separately, and a pattern over a term
1394                // cannot see them. A return of one value is a term with a name and a rule, and it
1395                // stays one.
1396                //
1397                // A return of none in a function whose answer went through memory is here too,
1398                // and for a different reason: what it gives back is not written in the IR at all.
1399                // The convention says the address the caller handed over comes back, and only the
1400                // signature says this function was handed one.
1401                //
1402                // And a return of one eighty bit value, for a third reason: what a rule would
1403                // write is an instruction leaving the value in a register, and this one is left on
1404                // the x87 stack instead. A rule could not name that stack any more than any other
1405                // rule about this type could.
1406                Opcode::Return
1407                    if self.source[self.source[inst].args].len() > 1
1408                        || self.sret().is_some()
1409                        || self.gives_back_x87(inst) =>
1410                {
1411                    let values = self.source[self.source[inst].args].to_vec();
1412                    self.returned(inst, values)?;
1413                    continue;
1414                }
1415                // A cast between a pointer and an integer of the same width, which on this
1416                // machine is every one the front end writes. No instruction at all, so no rule
1417                // could name one.
1418                Opcode::PtrToInt | Opcode::IntToPtr => {
1419                    self.rename(inst)?;
1420                    continue;
1421                }
1422                // A barrier, which is one instruction or none depending on the ordering. Written
1423                // by name because there is nothing about it a rule could be proved against, the
1424                // way there is nothing to prove about the address of a symbol.
1425                Opcode::Fence => {
1426                    self.barrier(inst)?;
1427                    continue;
1428                }
1429                // An ordered load or store that `crate::expand::orderings` left alone, which on a
1430                // machine that is not total store order is every one stronger than relaxed. Written
1431                // by name for the barrier's reason: what it adds to the plain access is an ordering.
1432                Opcode::AtomicLoad | Opcode::AtomicStore if self.on_aarch64() => {
1433                    self.ordered(inst)?;
1434                    continue;
1435                }
1436                // A hint, written by name for the reason a barrier is and one step further: not
1437                // only is there no equality for a proof to discharge, there is nothing about the
1438                // program around it either. Which of the four instructions it is comes out of the
1439                // number the builtin was given, which is beside the instruction rather than in it.
1440                Opcode::Prefetch => {
1441                    self.hint(inst)?;
1442                    continue;
1443                }
1444                // Stopping, written by name for the first half of the barrier's reason: it
1445                // computes nothing, so there is no term for a rule to replace, and what makes it
1446                // right is what the operating system does with the fault rather than anything a
1447                // proof over bitvectors could discharge.
1448                Opcode::Trap => {
1449                    self.trap(inst);
1450                    continue;
1451                }
1452                // A compare and exchange, which is written by name because it produces two values
1453                // and a rule produces one. The replacement of a rule is one term, a term names the
1454                // value an instruction computes, and there is no way in that language to say that
1455                // an instruction leaves an answer in one place and a yes or no in another.
1456                Opcode::Cmpxchg => {
1457                    self.exchange(inst)?;
1458                    continue;
1459                }
1460                // A read modify write, which is written by name for a different reason: it produces
1461                // one value, so a rule could name it, and what it does is not in the head a rule
1462                // matches on. Every one of the thirteen operations is the same opcode at the same
1463                // type and differs only in what is carried beside it, so one pattern would be all
1464                // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1465                // since `crate::retry` turned the rest into loops a long way above this.
1466                Opcode::AtomicRmw => {
1467                    self.modify(inst)?;
1468                    continue;
1469                }
1470                // An `asm` statement, whose lowering is its template and there is no term for a
1471                // string. Written by name for the reason a barrier is, and before the x87 arm
1472                // below so that an `asm` holding a `long double` is refused as the `asm` it is
1473                // rather than as an instruction nothing computes.
1474                Opcode::InlineAsm => {
1475                    // The template is read as x86 assembly, and that reader is the only one there
1476                    // is. AArch64 keeps every template as text, and any other machine's `asm` is
1477                    // refused here rather than read as the wrong language.
1478                    if self.on_aarch64() {
1479                        self.spelled(inst)?;
1480                        continue;
1481                    }
1482                    if !std::ptr::eq(self.selector.shapes, &x86_64::MACHINE) {
1483                        return Err(self.unsupported(inst));
1484                    }
1485                    if self.touches_x87(inst) {
1486                        self.x87_assembly(inst)?;
1487                        continue;
1488                    }
1489                    self.assembly(inst)?;
1490                    continue;
1491                }
1492                // Anything at all with an eighty bit float in it, which is the one arm here
1493                // chosen by a type rather than by an opcode, because what makes these different
1494                // is not what they do but where the value is. A `long double` has no register,
1495                // so it has no name in `crate::term` and no rule could bind one: every one of
1496                // these is a group of instructions over a frame slot, written out below.
1497                //
1498                // Last of the arms, so that a call and a return with one of these in them reach
1499                // the convention first and are refused by it, which is the truer answer: what is
1500                // wrong there is where the value has to travel and not that nothing can compute
1501                // it.
1502                _ if self.touches_x87(inst) => {
1503                    self.x87(inst)?;
1504                    continue;
1505                }
1506                _ => {}
1507            }
1508            let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1509            self.emit(inst, &matched)?;
1510            // After it is built rather than when it matched, so that what is recorded is the rules
1511            // this function was lowered by and not the rules something was tried with.
1512            self.fired.mark(matched.rule);
1513        }
1514        // Whichever block the walk ended in rather than the one it started in. The two are the
1515        // same block for every function that does not save a place for a `__builtin_longjmp`, and
1516        // where they differ it is the last of them that the terminator and the arms belong to.
1517        // See [`Self::saves_place`].
1518        let last = self.at.expect("a block is being filled");
1519        self.edges(block, last)?;
1520        // Now that the block is filled, the instruction after each place an assignment was is the
1521        // first one it holds its value at. One with nothing after it, which a block ending in the
1522        // assignment would be, stays unanswered.
1523        if let Some(marks) = self.marks.get_mut(&block) {
1524            for &(before, at, last) in &reached {
1525                let first = match last {
1526                    Some(last) => self.out.next_inst(last),
1527                    None => self.out.insts(at).next(),
1528                };
1529                for mark in marks.iter_mut().filter(|(after, _)| *after == before) {
1530                    mark.1 = first;
1531                }
1532            }
1533        }
1534        Ok(())
1535    }
1536
1537    /// One call, which is built from the convention rather than matched against the table for the
1538    /// same reason the arguments of the function itself are.
1539    ///
1540    /// The arguments are read before the call is built, which is what materializes a constant
1541    /// argument into a register, since no call passes an immediate.
1542    ///
1543    /// A call to a name and a call through an address are both here, and what tells them apart is
1544    /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1545    /// reads. Through an address the first operand is the address and the arguments are the ones
1546    /// behind it, and everything after that is the same: where each argument goes, where the value
1547    /// comes back and which registers are gone across it are the convention's answers and the
1548    /// convention does not ask what is being called.
1549    fn called(&mut self, inst: Inst) -> Result<u32, Unsupported> {
1550        let data = &self.source[inst];
1551        let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1552        let info = self.source[info];
1553        let indirect = data.opcode == Opcode::CallIndirect;
1554
1555        let values: Vec<Value> = self.source[data.args].to_vec();
1556        let callee = if indirect {
1557            let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1558            abi::Callee::Through(self.reg_of(address)?)
1559        } else {
1560            abi::Callee::Named(info.callee.ok_or_else(|| self.unsupported(inst))?)
1561        };
1562
1563        // What the ABI asks of each argument, read out before any of them is, because reading one
1564        // borrows the function this is a table in. The ones the signature names are the signature's
1565        // answer and the ones behind them are the call's, which is where a structure passed to a
1566        // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1567        let signature = &self.source[info.signature];
1568        let variadic = signature.variadic;
1569        let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1570        let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1571        // Every value that comes back and not only the first. A structure small enough to travel
1572        // in registers comes back in up to two of them, and which register each half is in is the
1573        // convention's answer, which is why the whole list goes to the same place the arguments do
1574        // rather than to a rule.
1575        let returns: Vec<Type> = signature.return_types().collect();
1576
1577        let mut args = Vec::with_capacity(values.len());
1578        for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1579            let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1580            let abi = abi.copied().unwrap_or_default();
1581            let ty = self.source[value].ty;
1582            // What travels for an eighty bit value is its bytes, so what the call is handed is
1583            // where they are rather than a register they are in, and there is no register they
1584            // could be in. Everything else about it is a sixteen byte object passed by value and
1585            // is built by the same code.
1586            let reg =
1587                if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1588            args.push(abi::Passing { ty, reg, abi });
1589        }
1590        let block = self.at.expect("a block is being filled");
1591        let what = abi::Calling {
1592            callee,
1593            args: &args,
1594            returns: &returns,
1595            variadic,
1596            named: named.len(),
1597            at: self.source.span(inst),
1598        };
1599        let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
1600            .map_err(|refused| Unsupported::Call { inst, refused })?;
1601        let calls = &mut self.stack.calls;
1602        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1603        // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1604        // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1605        // front of everything the block does next, and after it the value is in its slot and is
1606        // read the way every other one is. A complex one is two of them, the real half on top, so
1607        // taking them off in order leaves each in its own slot and the stack empty.
1608        let results: Vec<Value> = self.source[inst].results().collect();
1609        let types: Vec<Type> = results.iter().map(|&result| self.source[result].ty).collect();
1610        if abi::back_on_x87(&types) {
1611            let span = self.source.span(inst);
1612            for result in results {
1613                let into = self.x87_slot(result);
1614                let into = self.through(into);
1615                self.x87_at("fstp_t", span, into);
1616            }
1617            return Ok(made.outgoing);
1618        }
1619        for (result, &reg) in results.into_iter().zip(&made.results) {
1620            self.regs[result.index()] = Some(reg);
1621        }
1622        Ok(made.outgoing)
1623    }
1624
1625    /// One `tail_call`, as the call and a return of what it gave back.
1626    ///
1627    /// The call is written down for [`crate::tail::jumps`] when it can be made after the frame is
1628    /// gone. That is when it put nothing in the argument area, which is the bottom of this frame,
1629    /// and when the answer comes back in registers, since one on the x87 stack is taken off and put
1630    /// back by instructions after the call. A call that is not written down stays a call and a
1631    /// return, which is what the IR said before `crate::tail::mark` read it.
1632    fn tail_called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1633        let outgoing = self.called(inst)?;
1634        let block = self.at.expect("a block is being filled");
1635        let call = self.out.insts(block).last().expect("the call just built");
1636        let values: Vec<Value> = self.source[inst].results().collect();
1637        let x87 = self.x87_values(&values);
1638        self.returned(inst, values)?;
1639        if outgoing == 0 && !x87 && self.sret().is_none() {
1640            let returns = self.out.insts(block).skip_while(|&at| at != call).skip(1).collect();
1641            self.stack.tails.push(crate::tail::Tail { call, returns });
1642        }
1643        Ok(())
1644    }
1645
1646    /// The pointer a function returning through memory was handed, or nothing in a function that
1647    /// was not.
1648    ///
1649    /// It is the first parameter and the signature is what says so, since in the IR it is an
1650    /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1651    /// like that and no entry block has nothing to give back and no body to give it back from.
1652    fn sret(&self) -> Option<Value> {
1653        let first = self.source.signature().params.first()?;
1654        if !matches!(first.abi, Abi::Sret { .. }) {
1655            return None;
1656        }
1657        self.source[self.source.entry()?].params.first().copied()
1658    }
1659
1660    /// One `return` the convention has to write, as the place each value has to be in by the end.
1661    ///
1662    /// One pseudo per value, each a read constrained to a return register, which is what a return
1663    /// of one value already is and is the whole of what either does. The `ret` itself comes from
1664    /// the epilogue for both, long after this, because the frame has to be given back first.
1665    ///
1666    /// The two register files are counted separately, so a structure of a `double` and a `long`
1667    /// leaves the `double` in the first vector register and the `long` in the first integer one
1668    /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1669    /// the other side of the call, which is what makes the two ends agree.
1670    ///
1671    /// A function whose answer went through memory gives back the address it was handed, in front
1672    /// of nothing else, because a signature that returns that way returns nothing else. That the
1673    /// caller already knows the address is not enough: it is allowed to read the register instead,
1674    /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1675    /// is usually the right answer by accident, and one call in the body is enough to make it a
1676    /// wild pointer, which is why this is written rather than left to luck.
1677    ///
1678    /// Where everything goes is worked out before anything is written, so a return this cannot
1679    /// make leaves no half of one behind.
1680    /// Whether what a `return` gives back goes back on the x87 stack, per [`abi::back_on_x87`].
1681    fn gives_back_x87(&self, inst: Inst) -> bool {
1682        self.x87_values(&self.source[self.source[inst].args])
1683    }
1684
1685    /// Whether those values go back on the x87 stack, per [`abi::back_on_x87`].
1686    fn x87_values(&self, values: &[Value]) -> bool {
1687        let types: Vec<Type> = values.iter().map(|&value| self.source[value].ty).collect();
1688        abi::back_on_x87(&types)
1689    }
1690
1691    fn returned(&mut self, inst: Inst, values: Vec<Value>) -> Result<(), Unsupported> {
1692        let (mut ints, mut floats) = (0usize, 0usize);
1693        let mut parts = Vec::with_capacity(values.len() + 1);
1694        // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1695        // and is the one place a value is left rather than put in a register. So the whole of the
1696        // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1697        // `ret`, which is the one time in this file that is true and is what the convention asks
1698        // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1699        // the unit. A complex one loads its imaginary half first so that the real half ends up on
1700        // top of it, in `st(0)`, with the imaginary half under it in `st(1)`.
1701        if self.x87_values(&values) && self.sret().is_none() {
1702            let span = self.source.span(inst);
1703            for &value in values.iter().rev() {
1704                let from = self.x87_slot(value);
1705                let from = self.through(from);
1706                self.x87_at("fld_t", span, from);
1707            }
1708            return Ok(());
1709        }
1710        for value in self.sret().into_iter().chain(values) {
1711            let ty = self.source[value].ty;
1712            let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1713            // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1714            // says so itself, and a type that travels perfectly well ran out of registers.
1715            let missing = abi::refuses(ty, self.selector.abi).unwrap_or(Missing::NoRoom);
1716            let name =
1717                (self.selector.abi.ret)(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1718            *at += 1;
1719            // The register is the target's answer and not one worked out here, the same as it is
1720            // for a return of one value, so that both halves of a pair and every rule that writes
1721            // half of one are reading the same table.
1722            let opcode =
1723                name.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
1724            let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
1725            let [desc] = descs else { return Err(self.unsupported(inst)) };
1726            parts.push((self.names.intern(name), self.reg_of(value)?, *desc));
1727        }
1728
1729        let block = self.at.expect("a block is being filled");
1730        let span = self.source.span(inst);
1731        for (opcode, reg, desc) in parts {
1732            let operand = mir::Operand {
1733                reg,
1734                class: desc.class,
1735                role: desc.role,
1736                constraint: desc.constraint,
1737            };
1738            self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1739        }
1740        Ok(())
1741    }
1742
1743    /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1744    /// address of them is one instruction.
1745    ///
1746    /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1747    /// the frame in every function, and its displacement is left at nothing because there is no
1748    /// frame yet. Which instruction is waiting for which local is remembered, and
1749    /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1750    ///
1751    /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1752    /// that is what stops it being folded into something else. An operand shown as the
1753    /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1754    /// name is one no pattern can reach past, and the address it computes is always in a register
1755    /// by the time anything reads it.
1756    fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1757        let data = &self.source[inst];
1758        // A variable length array carries the size it wants as an operand rather than in the
1759        // instruction, which is the whole of what tells the two apart here.
1760        if let Some(&size) = self.source[data.args].first() {
1761            return self.grow(inst, size);
1762        }
1763        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1764        let info = self.source[mem];
1765        let size = u32::try_from(info.size)
1766            .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1767        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1768
1769        // At least one, because the frame divides by the alignment and an object with no
1770        // alignment at all is one the front end had nothing to say about rather than one that may
1771        // go anywhere.
1772        let index = self.stack.locals.len();
1773        self.stack.locals.push(Local { size, align: info.align.max(1) });
1774        if let Some(decl) = self.source.mem_decl(mem) {
1775            self.stack.declared.push((index, decl));
1776        }
1777
1778        let block = self.at.expect("a block is being filled");
1779        let reg = self.new_reg(result);
1780        let span = self.source.span(inst);
1781        let lea = self.named(self.selector.frame.lea);
1782        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1783        let made =
1784            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1785        self.stack.addresses.push((made, index));
1786        Ok(())
1787    }
1788
1789    /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1790    /// is what a variable length array is.
1791    ///
1792    /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1793    /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1794    /// where the declaration stands, which is two instructions:
1795    ///
1796    /// ```text
1797    ///   sub sp, bytes     the stack pointer moves down over the memory, which is what takes it
1798    ///   lea reg, [sp+n]   where the memory starts, which is above the outgoing argument area
1799    /// ```
1800    ///
1801    /// The displacement is left at nothing for the reason the constant kind leaves its own at
1802    /// nothing, and for a different number: that area belongs to the arguments of whatever this
1803    /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1804    /// how big it is is not known until every call in the function has been seen.
1805    ///
1806    /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1807    /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1808    /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1809    ///
1810    /// Two instructions here and not always two in the finished function. On a command line that
1811    /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1812    /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1813    /// instruction is written down in [`Stack::grown`] as well as left where it is.
1814    ///
1815    /// An array wanting more alignment than the convention leaves the stack pointer with does not
1816    /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1817    /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1818    /// is a block asking for the convention's alignment like any other. The refusal below is what
1819    /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1820    /// would be a second rounding of a register the frame already rounded, and after it no
1821    /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1822    fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1823        let data = &self.source[inst];
1824        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1825        let info = self.source[mem];
1826        if info.align > self.conv.stack_align {
1827            return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1828        }
1829        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1830        let bytes = self.reg_of(size)?;
1831
1832        let block = self.at.expect("a block is being filled");
1833        let span = self.source.span(inst);
1834        let stack = mir::Reg::physical(self.conv.stack_pointer);
1835        let grow = self.named(self.selector.frame.grow);
1836        let took = self
1837            .out
1838            .build(block, grow)
1839            .at(span)
1840            .operand(mir::Operand::write(stack, self.gpr))
1841            .operand(mir::Operand::read(stack, self.gpr))
1842            .operand(mir::Operand::read(bytes, self.gpr))
1843            .finish();
1844        self.stack.grown.push(took);
1845
1846        let reg = self.new_reg(result);
1847        let lea = self.named(self.selector.frame.lea);
1848        let sp = mir::Operand::read(stack, self.gpr);
1849        let made =
1850            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1851        self.stack.dynamic.push(made);
1852        self.stack.grown_at.get_or_insert(inst);
1853        Ok(())
1854    }
1855
1856    /// Where the stack pointer is, kept so that something later can put it back.
1857    ///
1858    /// One move out of the stack pointer and one move into it, which is the whole of what the two
1859    /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1860    /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1861    /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1862    /// jump out of the scope gives the bytes back on the way out.
1863    ///
1864    /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1865    /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
1866    /// which is exactly the register that still means something after the stack pointer has moved.
1867    fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
1868        let data = &self.source[inst];
1869        let block = self.at.expect("a block is being filled");
1870        let span = self.source.span(inst);
1871        let stack = mir::Reg::physical(self.conv.stack_pointer);
1872        let mov =
1873            self.selector.frame.moves(self.gpr).expect("a class the target says how to move").mov;
1874        let mov = self.named(mov);
1875        let (write, read) = if into {
1876            let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
1877            (stack, self.reg_of(saved)?)
1878        } else {
1879            let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1880            (self.new_reg(result), stack)
1881        };
1882        self.out
1883            .build(block, mov)
1884            .at(span)
1885            .operand(mir::Operand::write(write, self.gpr))
1886            .operand(mir::Operand::read(read, self.gpr))
1887            .finish();
1888        // Only the write is a move of the stack pointer, and it is the one that makes the frame a
1889        // growing one. A read of it in a function that never writes it back is a function that
1890        // asked where the stack was and did nothing with the answer.
1891        if into {
1892            self.stack.grown_at.get_or_insert(inst);
1893        }
1894        Ok(())
1895    }
1896
1897    /// Whether an instruction has an eighty bit float anywhere in it.
1898    ///
1899    /// Producing one and reading one are the same question here, because what makes one of these
1900    /// different from every other instruction is not the operation but where the value is. A
1901    /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
1902    /// of the time, and neither of those is somewhere the operand of a rule could point.
1903    fn touches_x87(&self, inst: Inst) -> bool {
1904        let data = &self.source[inst];
1905        data.results().any(|value| on_x87(self.source[value].ty))
1906            || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
1907    }
1908
1909    /// Everything that happens to an eighty bit float, as the group of instructions it is.
1910    ///
1911    /// The first six move one, and every one of those is a load, a store, or a load and a store at
1912    /// two different formats, because that is the whole of what this machine converts with: the
1913    /// x87 has no instruction that turns one thing on its stack into another, so a widening is
1914    /// `fld` of the narrow format and a narrowing is `fstp` of it.
1915    ///
1916    /// The rest work on one, and they are here rather than in a rule for the same reason the six
1917    /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
1918    /// top of a stack nothing allocates from, so there is no value in the middle of the group for
1919    /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
1920    /// two instructions folded into one opcode, which is where the byte it produces comes from.
1921    ///
1922    /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
1923    /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
1924    /// below is answered by a pop a line or two later, so no two groups can ever be looking at
1925    /// the same eight registers.
1926    fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
1927        match self.source[inst].opcode {
1928            Opcode::Load => self.x87_load(inst),
1929            Opcode::Store => self.x87_store(inst),
1930            Opcode::FPExt => self.x87_widen(inst),
1931            Opcode::FPTrunc => self.x87_narrow(inst),
1932            Opcode::SIToFP => self.x87_from_signed(inst),
1933            Opcode::FPToSI => self.x87_to_signed(inst),
1934            Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
1935            Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
1936            Opcode::FMul => self.x87_arith(inst, "fmul_p"),
1937            Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
1938            Opcode::FNeg => self.x87_flip(inst),
1939            Opcode::FCmp => self.x87_compare(inst),
1940            Opcode::FConst => self.x87_const(inst),
1941            _ => Err(self.unsupported(inst)),
1942        }
1943    }
1944
1945    /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
1946    /// into slots of the block's own.
1947    ///
1948    /// What crosses an edge for a value of this type is an address, because the value is sixteen
1949    /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
1950    /// second edge into the same block hands over a second one, and a read after the block would
1951    /// then be a read of whichever edge was taken rather than of one place. So the block has a
1952    /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
1953    /// every other type gets from the allocator.
1954    ///
1955    /// Every load runs before every store and the stores run backwards, so all of the values are
1956    /// on the x87 stack at once and nothing reads a slot another one has already written. That
1957    /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
1958    /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
1959    /// deep, and a block with more of these than that is refused rather than copied in an order
1960    /// that could be wrong.
1961    fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
1962        let Some(&(first, _)) = arriving.first() else { return Ok(()) };
1963        if arriving.len() > X87_DEPTH {
1964            let ty = self.source[first].ty;
1965            return Err(Unsupported::Phi { block, count: arriving.len(), ty });
1966        }
1967        // A block parameter comes from no instruction, so what this points at is the first thing
1968        // in the block, which is where a reader looking for the copy would look.
1969        let first_inst = self.source.insts(block).next();
1970        let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
1971        for &(_, reg) in arriving {
1972            let from = self.through(reg);
1973            self.x87_at("fld_t", span, from);
1974        }
1975        for &(param, _) in arriving.iter().rev() {
1976            let into = self.x87_slot(param);
1977            let into = self.through(into);
1978            self.x87_at("fstp_t", span, into);
1979        }
1980        Ok(())
1981    }
1982
1983    /// The frame slot an eighty bit value lives in, as its address in a fresh register.
1984    ///
1985    /// The slot is the value's for the whole function and is taken the first time somebody asks.
1986    /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
1987    /// address kept in a register from the definition to the last use would hold a general purpose
1988    /// register open across everything in between, and a function with a handful of these in it
1989    /// would spend its registers on addresses of things rather than on things.
1990    fn x87_slot(&mut self, value: Value) -> mir::Reg {
1991        // An argument of the function has a slot already and it is the caller's. The convention
1992        // puts the bytes in the argument area and hands over where they are, so the address that
1993        // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
1994        // value of this type once it exists, so nothing writes to the caller's copy either. A
1995        // parameter of any other block is not this: what arrived there is an address a predecessor
1996        // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
1997        // bytes landed in is the one below.
1998        let entry = self.source.entry();
1999        if let (Def::Param { block, .. }, Some(reg)) =
2000            (self.source[value].def, self.regs[value.index()])
2001        {
2002            if entry == Some(block) {
2003                return reg;
2004            }
2005        }
2006        let index = match self.slots[value.index()] {
2007            Some(index) => index,
2008            None => {
2009                let index = self.stack.locals.len();
2010                self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
2011                self.slots[value.index()] = Some(index);
2012                index
2013            }
2014        };
2015        let block = self.at.expect("a block is being filled");
2016        self.frame_address(block, index)
2017    }
2018
2019    /// The bytes a value crosses between a register and the x87 stack through, as their address
2020    /// in a fresh register.
2021    fn x87_crossing(&mut self) -> mir::Reg {
2022        let index = match self.crossing {
2023            Some(index) => index,
2024            None => {
2025                let index = self.stack.locals.len();
2026                self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
2027                self.crossing = Some(index);
2028                index
2029            }
2030        };
2031        let block = self.at.expect("a block is being filled");
2032        self.frame_address(block, index)
2033    }
2034
2035    /// The two control words, as the address of the first of them in a fresh register.
2036    fn x87_control(&mut self) -> mir::Reg {
2037        let index = match self.control {
2038            Some(index) => index,
2039            None => {
2040                let index = self.stack.locals.len();
2041                self.stack.locals.push(Local { size: 4, align: 4 });
2042                self.control = Some(index);
2043                index
2044            }
2045        };
2046        let block = self.at.expect("a block is being filled");
2047        self.frame_address(block, index)
2048    }
2049
2050    /// An address held in a register, as the addressing mode that reaches it.
2051    fn through(&self, reg: mir::Reg) -> mir::Mem {
2052        mir::Mem::at(mir::Operand::read(reg, self.gpr))
2053    }
2054
2055    /// One instruction of a group, which names an address and nothing else.
2056    ///
2057    /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
2058    /// the mnemonic rather than in an operand, so there is no register to write down and no
2059    /// register the allocator gets a say in.
2060    fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
2061        let block = self.at.expect("a block is being filled");
2062        let opcode = self.named(name);
2063        self.out.build(block, opcode).at(span).mem(at).finish();
2064    }
2065
2066    /// The one instruction of a group that reaches the program's own memory.
2067    ///
2068    /// A `long double` moves in two instructions with a frame slot at one end of them, and the
2069    /// other end is the address the program wrote. That end is the access, so it is the one that
2070    /// carries what the program said about it, and the trip through the slot is this compiler's
2071    /// own business the way a spill is. See [`Self::carried`].
2072    fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
2073        let block = self.at.expect("a block is being filled");
2074        let opcode = self.named(name);
2075        let (span, flags) = (self.source.span(inst), self.carried(inst));
2076        self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
2077    }
2078
2079    /// One instruction of a group that names nothing at all.
2080    ///
2081    /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
2082    /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
2083    /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
2084    /// from. What it works on is which two pushes came before it, which is a fact about the order
2085    /// of the group and is why the group is written in one place.
2086    fn x87_only(&mut self, name: &str, span: Span) {
2087        let block = self.at.expect("a block is being filled");
2088        let opcode = self.named(name);
2089        self.out.build(block, opcode).at(span).finish();
2090    }
2091
2092    /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
2093    ///
2094    /// Two instructions rather than the two general purpose moves the same sixteen bytes would
2095    /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
2096    /// in the format it was already in and comes back off in it, so a signalling NaN stays one
2097    /// and nothing is raised. Which is what makes this a copy at all.
2098    fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
2099        let (args, result) = self.ends(inst)?;
2100        let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
2101        let span = self.source.span(inst);
2102        let from = self.reg_of(address)?;
2103        let from = self.through(from);
2104        let into = self.x87_slot(result);
2105        let into = self.through(into);
2106        self.x87_touching("fld_t", inst, from);
2107        self.x87_at("fstp_t", span, into);
2108        Ok(())
2109    }
2110
2111    /// A `store` of a `long double`: the same pair the other way round.
2112    fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
2113        let args = self.source[self.source[inst].args].to_vec();
2114        let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
2115        let span = self.source.span(inst);
2116        let from = self.x87_slot(value);
2117        let from = self.through(from);
2118        let into = self.reg_of(address)?;
2119        let into = self.through(into);
2120        self.x87_at("fld_t", span, from);
2121        self.x87_touching("fstp_t", inst, into);
2122        Ok(())
2123    }
2124
2125    /// A `float`, a `double` or an integer becoming a `long double`.
2126    ///
2127    /// Through memory, because the x87 reads memory and nothing else: the value is in a register
2128    /// the machine has and the unit has no way to be handed one, so it is written to the crossing
2129    /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
2130    /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
2131    /// sixty four bit integer outright, so none of the four can round and none can raise.
2132    fn x87_across(
2133        &mut self,
2134        inst: Inst,
2135        put: &'static str,
2136        class: RegClass,
2137        get: &'static str,
2138    ) -> Result<(), Unsupported> {
2139        let (args, result) = self.ends(inst)?;
2140        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2141        let span = self.source.span(inst);
2142        let value = self.reg_of(source)?;
2143        let across = self.x87_crossing();
2144        let across = self.through(across);
2145        let into = self.x87_slot(result);
2146        let into = self.through(into);
2147
2148        let block = self.at.expect("a block is being filled");
2149        let store = self.named(put);
2150        self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
2151        self.x87_at(get, span, across);
2152        self.x87_at("fstp_t", span, into);
2153        Ok(())
2154    }
2155
2156    /// A `long double` becoming a `float`, a `double` or an integer.
2157    ///
2158    /// Through memory for the reason above and in the same three instructions backwards. The two
2159    /// that go to a float round to nearest, which is what the control word says unless somebody
2160    /// has changed it and is what C wants. The two that go to an integer do not, which is why they
2161    /// do not come here.
2162    fn x87_back(
2163        &mut self,
2164        inst: Inst,
2165        put: &'static str,
2166        get: &'static str,
2167        class: RegClass,
2168    ) -> Result<(), Unsupported> {
2169        let (args, result) = self.ends(inst)?;
2170        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2171        let span = self.source.span(inst);
2172        let from = self.x87_slot(source);
2173        let from = self.through(from);
2174        let across = self.x87_crossing();
2175        let across = self.through(across);
2176
2177        self.x87_at("fld_t", span, from);
2178        self.x87_at(put, span, across);
2179        let block = self.at.expect("a block is being filled");
2180        let reg = self.new_reg(result);
2181        let load = self.named(get);
2182        self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
2183        Ok(())
2184    }
2185
2186    /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
2187    fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
2188        let sse = self.conv.sse_class;
2189        match self.source[self.narrow(inst)?].ty.bits() {
2190            32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
2191            64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
2192            _ => Err(self.unsupported(inst)),
2193        }
2194    }
2195
2196    /// An `fptrunc` down from a `long double`, which is the other direction of the same.
2197    fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
2198        let sse = self.conv.sse_class;
2199        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2200        match self.source[result].ty.bits() {
2201            32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
2202            64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
2203            _ => Err(self.unsupported(inst)),
2204        }
2205    }
2206
2207    /// A `sitofp` up to a `long double`.
2208    ///
2209    /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
2210    /// before it converts one and the front end writes that widening down. An unsigned integer is
2211    /// not here at all: `fild` reads its operand as signed, so a value above the signed range
2212    /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
2213    /// rather than a move and waits with the rest of it.
2214    fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2215        let gpr = self.gpr;
2216        match self.source[self.narrow(inst)?].ty.bits() {
2217            32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
2218            64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
2219            _ => Err(self.unsupported(inst)),
2220        }
2221    }
2222
2223    /// An `fptosi` down from a `long double`, which is the one conversion here with no single
2224    /// instruction behind it.
2225    ///
2226    /// C cuts towards zero and the unit rounds the way its control word says, so the store that
2227    /// takes the value off the stack is wrapped in the control word being saved, changed and put
2228    /// back. Five instructions around the one that does the work, and three more moving the word
2229    /// through a register, because this machine has no way to OR a constant into memory at this
2230    /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
2231    /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
2232    /// that can gate an instruction on a feature yet.
2233    fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2234        let (args, result) = self.ends(inst)?;
2235        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2236        let (put, get) = match self.source[result].ty.bits() {
2237            32 => ("fistp_l", "mov_rm_32"),
2238            64 => ("fistp_ll", "mov_rm_64"),
2239            _ => return Err(self.unsupported(inst)),
2240        };
2241        let span = self.source.span(inst);
2242        let gpr = self.gpr;
2243        let from = self.x87_slot(source);
2244        let from = self.through(from);
2245        let across = self.x87_crossing();
2246        let across = self.through(across);
2247        let control = self.x87_control();
2248        let saved = self.through(control).plus(0);
2249        let cut = self.through(control).plus(2);
2250
2251        // The word the unit has now, into the first of the two slots and into a register, with the
2252        // rounding field turned to truncate on the way to the second.
2253        self.x87_at("fnstcw", span, saved);
2254        let block = self.at.expect("a block is being filled");
2255        let was = self.out.new_vreg(gpr);
2256        let read = self.named("mov_rm_16");
2257        self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
2258        let now = self.out.new_vreg(gpr);
2259        let set = self.named("or_ri_16");
2260        // Two address, which is written out here rather than taken from the two shorthands
2261        // because the shorthands leave an operand unconstrained: this machine ORs into the
2262        // register it read, so the two have to be the same one and only the constraint says so.
2263        self.out
2264            .build(block, set)
2265            .at(span)
2266            .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
2267            .operand(mir::Operand::read(was, gpr))
2268            .imm(X87_TRUNCATE)
2269            .finish();
2270        let write = self.named("mov_mr_16");
2271        self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
2272
2273        // The conversion itself, under the changed word, and then the word the unit had put back
2274        // before anything else runs.
2275        self.x87_at("fldcw", span, cut);
2276        self.x87_at("fld_t", span, from);
2277        self.x87_at(put, span, across);
2278        self.x87_at("fldcw", span, saved);
2279
2280        let block = self.at.expect("a block is being filled");
2281        let reg = self.new_reg(result);
2282        let load = self.named(get);
2283        self.out.build(block, load).at(span).def(reg, gpr).mem(across).finish();
2284        Ok(())
2285    }
2286
2287    /// A constant of this type, as the bits of it written into its slot.
2288    ///
2289    /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
2290    /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
2291    /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
2292    ///
2293    /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
2294    /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
2295    /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
2296    /// wide and they are unspecified in the psABI rather than zero.
2297    ///
2298    /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
2299    /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
2300    /// four instructions in the frame is what that costs until it does.
2301    fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
2302        let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
2303        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2304        let bits = self.source[imm].bits();
2305        let span = self.source.span(inst);
2306        let gpr = self.gpr;
2307        let slot = self.x87_slot(result);
2308        let low = self.through(slot).plus(0);
2309        let high = self.through(slot).plus(8);
2310
2311        let block = self.at.expect("a block is being filled");
2312        for (bytes, at, into) in
2313            [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
2314        {
2315            let held = self.out.new_vreg(gpr);
2316            let put = self.named(&format!("mov_ri_{into}"));
2317            self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
2318            let store = self.named(&format!("mov_mr_{into}"));
2319            self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
2320        }
2321        Ok(())
2322    }
2323
2324    /// One arithmetic instruction on two eighty bit values, as the four it takes.
2325    ///
2326    /// The left operand is pushed first and the right one on top of it, so the left ends up
2327    /// underneath and the answer wanted is the one below against the top in that order. Which of
2328    /// the two mnemonics computes that is a question about the spelling rather than about the
2329    /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
2330    /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
2331    /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
2332    /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
2333    ///
2334    /// An addition and a multiplication have one form each and do not care, which is why a test
2335    /// that reads the mnemonic back would not have caught this and one that computes a subtraction
2336    /// and checks the answer does.
2337    ///
2338    /// The answer is left where the deeper of the two was and the shallower is gone, which is what
2339    /// the `p` on the mnemonic means, so one push has already been paid back by the time the
2340    /// `fstp` runs and the stack is level again after it.
2341    ///
2342    /// Nothing here is folded and nothing is reused. Two values that are the same value get two
2343    /// pushes of the same slot, and an operand that was just computed is read back out of the slot
2344    /// it was written to rather than left on the stack, which costs a store and a load per
2345    /// instruction in an expression. Keeping a partial result on the stack across the next
2346    /// instruction's operands means knowing how deep the stack is at every point in the block, and
2347    /// that is a different thing from writing a group.
2348    fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
2349        let (args, result) = self.ends(inst)?;
2350        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2351        let span = self.source.span(inst);
2352        let left = self.x87_slot(left);
2353        let left = self.through(left);
2354        let right = self.x87_slot(right);
2355        let right = self.through(right);
2356        let into = self.x87_slot(result);
2357        let into = self.through(into);
2358        self.x87_at("fld_t", span, left);
2359        self.x87_at("fld_t", span, right);
2360        self.x87_only(with, span);
2361        self.x87_at("fstp_t", span, into);
2362        Ok(())
2363    }
2364
2365    /// A negation, which is a push, the sign bit turned over and a pop.
2366    ///
2367    /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
2368    /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
2369    /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
2370    /// negative zero and a signalling one at a NaN.
2371    fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
2372        let (args, result) = self.ends(inst)?;
2373        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2374        let span = self.source.span(inst);
2375        let from = self.x87_slot(source);
2376        let from = self.through(from);
2377        let into = self.x87_slot(result);
2378        let into = self.through(into);
2379        self.x87_at("fld_t", span, from);
2380        self.x87_only("fchs", span);
2381        self.x87_at("fstp_t", span, into);
2382        Ok(())
2383    }
2384
2385    /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
2386    ///
2387    /// The right operand is pushed first and the left one on top of it, which is the other way
2388    /// round from the arithmetic and is because `fucomip` asks about the top against what is under
2389    /// it: the comparison this machine can do is the top's, so the value the predicate is about
2390    /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
2391    /// flags are both inside the opcode, since what passes between those and the comparison is the
2392    /// flags and the flags are not something anything here can name.
2393    ///
2394    /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
2395    /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
2396    /// picked a different condition here than there would be a `long double` comparison that
2397    /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
2398    /// wider format is not allowed to do.
2399    ///
2400    /// The always false and the always true are refused rather than folded into a constant,
2401    /// because a comparison this machine never has to do is one the optimizer should have removed
2402    /// and an instruction here that quietly agreed with it would hide that it did not.
2403    fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2404        let Extra::FloatPred(pred) = self.source[inst].extra else {
2405            return Err(self.unsupported(inst));
2406        };
2407        let (args, result) = self.ends(inst)?;
2408        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2409        // Two of the fourteen need a second byte and an instruction to put the two together,
2410        // because they are two conditions at once: an ordered equal is equal and not unordered,
2411        // and an unordered not equal is either. The opcode carries all of that and says here only
2412        // that it writes somewhere else as well.
2413        let (name, reversed, both) = match pred {
2414            FloatPred::Ogt => ("fucomip_set_a", false, false),
2415            FloatPred::Oge => ("fucomip_set_ae", false, false),
2416            FloatPred::Olt => ("fucomip_set_a", true, false),
2417            FloatPred::Ole => ("fucomip_set_ae", true, false),
2418            FloatPred::One => ("fucomip_set_ne", false, false),
2419            FloatPred::Ord => ("fucomip_set_np", false, false),
2420            FloatPred::Uno => ("fucomip_set_p", false, false),
2421            FloatPred::Ueq => ("fucomip_set_e", false, false),
2422            FloatPred::Ult => ("fucomip_set_b", false, false),
2423            FloatPred::Ule => ("fucomip_set_be", false, false),
2424            FloatPred::Ugt => ("fucomip_set_b", true, false),
2425            FloatPred::Uge => ("fucomip_set_be", true, false),
2426            FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2427            FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2428            FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2429        };
2430        let (top, under) = if reversed { (right, left) } else { (left, right) };
2431
2432        let span = self.source.span(inst);
2433        let gpr = self.gpr;
2434        let under = self.x87_slot(under);
2435        let under = self.through(under);
2436        let top = self.x87_slot(top);
2437        let top = self.through(top);
2438        self.x87_at("fld_t", span, under);
2439        self.x87_at("fld_t", span, top);
2440
2441        let block = self.at.expect("a block is being filled");
2442        let reg = self.new_reg(result);
2443        // Taken before the instruction is started rather than inside it, since both come from the
2444        // same function being built and only one thing at a time may be adding to it.
2445        let spare = both.then(|| self.out.new_vreg(gpr));
2446        let opcode = self.named(name);
2447        let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2448        if let Some(spare) = spare {
2449            build = build.def(spare, gpr);
2450        }
2451        build.finish();
2452        Ok(())
2453    }
2454
2455    /// The operands and the one result of an instruction that has exactly one.
2456    fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2457        let data = &self.source[inst];
2458        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2459        Ok((&self.source[data.args], result))
2460    }
2461
2462    /// The operand of a conversion, which is the end of it that is not the `long double`.
2463    fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2464        let args = &self.source[self.source[inst].args];
2465        args.first().copied().ok_or_else(|| self.unsupported(inst))
2466    }
2467
2468    /// One `va_start`, as the fields of the list it was handed.
2469    ///
2470    /// On the four field list, two of them are numbers this already knows, and each costs an
2471    /// instruction to put in a register before it can be stored, because the machine here has no
2472    /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2473    /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2474    /// and the caller's argument area is where the parameters that had no register came from, which
2475    /// is the same place and the same fixup a parameter past the sixth already uses.
2476    ///
2477    /// On the list that is a pointer it is the second of those four and nothing else, since the
2478    /// whole of what that list says is where the walk is and the walk starts at the first argument
2479    /// the signature does not name. One `lea` and one store.
2480    ///
2481    /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2482    /// laid out, so that reading this beside that table is the whole of the check.
2483    fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2484        let Some(&list) = self.source[self.source[inst].args].first() else {
2485            return Err(self.unsupported(inst));
2486        };
2487        let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2488        let list = self.reg_of(list)?;
2489        let block = self.at.expect("a block is being filled");
2490        let span = self.source.span(inst);
2491
2492        let (save, incoming) = match started {
2493            Varargs::Pointer { incoming } => (None, incoming),
2494            Varargs::Fields { save, incoming, integers, floats } => {
2495                let counts = [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)];
2496                for (at, count) in counts {
2497                    self.store_small(list, at, i64::from(count), span);
2498                }
2499                (Some(save), incoming)
2500            }
2501            Varargs::Aapcs { save, incoming, integers_end, floats_end, integers, floats } => {
2502                let counts =
2503                    [(varargs::aapcs::GR_OFFS, integers), (varargs::aapcs::VR_OFFS, floats)];
2504                for (at, count) in counts {
2505                    self.store_small(list, at, i64::from(count), span);
2506                }
2507                let overflow = self.overflow(block, incoming, span);
2508                let integers_top = self.frame_address_plus(block, save, integers_end);
2509                let floats_top = self.frame_address_plus(block, save, floats_end);
2510                let fields = [
2511                    (varargs::aapcs::STACK, overflow),
2512                    (varargs::aapcs::GR_TOP, integers_top),
2513                    (varargs::aapcs::VR_TOP, floats_top),
2514                ];
2515                for (at, held) in fields {
2516                    self.store_word(list, at, held, span);
2517                }
2518                return Ok(());
2519            }
2520        };
2521
2522        // At the front of the list when that address is the whole of it, and at the field the
2523        // layout gives it when there are four, with the save area behind it.
2524        let overflow = self.overflow(block, incoming, span);
2525        let fields = match save {
2526            None => vec![(0, overflow)],
2527            Some(save) => {
2528                let save = self.frame_address(block, save);
2529                vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2530            }
2531        };
2532        for (at, held) in fields {
2533            self.store_word(list, at, held, span);
2534        }
2535        Ok(())
2536    }
2537
2538    /// The first argument the signature did not name, which is as far up the caller's argument
2539    /// area as the ones it did name reached. Nothing here knows where that area is, so the distance
2540    /// is recorded the way a parameter read out of it is and finished with it.
2541    fn overflow(&mut self, block: mir::Block, incoming: u32, span: Span) -> mir::Reg {
2542        let overflow = self.out.new_vreg(self.gpr);
2543        let lea = self.named(self.selector.frame.lea);
2544        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2545        let made = self
2546            .out
2547            .build(block, lea)
2548            .at(span)
2549            .def(overflow, self.gpr)
2550            .mem(mir::Mem::at(sp))
2551            .finish();
2552        self.stack.arguments.push((made, incoming));
2553        overflow
2554    }
2555
2556    /// Writes a small constant into a 32 bit field of a list.
2557    fn store_small(&mut self, list: mir::Reg, at: i64, value: i64, span: Span) {
2558        let block = self.at.expect("a block is being filled");
2559        let held = self.out.new_vreg(self.gpr);
2560        let load = mir::Opcode::new(self.names.intern(self.selector.abi.small));
2561        self.out.build(block, load).at(span).def(held, self.gpr).imm(value).finish();
2562
2563        let head = (self.selector.abi.store)(Type::int(32)).expect("a store of a word");
2564        let store = mir::Opcode::new(self.names.intern(head));
2565        let mem = self.field(list, at);
2566        self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2567    }
2568
2569    /// Writes an address into a pointer field of a list.
2570    fn store_word(&mut self, list: mir::Reg, at: i64, held: mir::Reg, span: Span) {
2571        let block = self.at.expect("a block is being filled");
2572        let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
2573        let store = mir::Opcode::new(self.names.intern(head));
2574        let mem = self.field(list, at);
2575        self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2576    }
2577
2578    /// One field of a list, as the addressing mode that reaches it.
2579    fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2580        let base = mir::Operand::read(list, self.gpr);
2581        mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2582    }
2583
2584    /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2585    ///
2586    /// That is x86-64, and [`Selector::symbols`] is what says so. AArch64 writes the same thing as
2587    /// an `adrp` of the page and an `add` of the low twelve bits, which is one opcode with the name
2588    /// as its own symbol and no addressing mode, and the table read is an `adrp` and an `ldr`.
2589    ///
2590    /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2591    /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2592    /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2593    /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2594    /// the encoder emits the relocation, because a call to a name the file does not define needed
2595    /// them first.
2596    ///
2597    /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2598    /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2599    /// this program can work out, and the address of a function this file merely declares is not
2600    /// such a number. The load reads the address out of the slot the linker fills in instead. The
2601    /// linker turns it back into the `lea` when the name turns out to have been here all along,
2602    /// so this is not slower in the case that was already right.
2603    ///
2604    /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2605    /// being folded into the instruction that reads it. Folding it is the right thing to do and
2606    /// is what turns a load of a global from two instructions into one, but it is a separate
2607    /// question about addressing modes and issue #282 is it. Until then the address is in a
2608    /// register before anything uses it, which is correct and one instruction longer.
2609    ///
2610    /// What this does not do is give the name anything to refer to. A module carries its globals
2611    /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2612    /// reference the linker cannot resolve. Issue #293 is the other half.
2613    ///
2614    /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2615    fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2616        let data = &self.source[inst];
2617        let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2618        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2619        if self.elsewhere.thread(symbol) {
2620            return self.thread_address(inst, symbol, result);
2621        }
2622
2623        let block = self.at.expect("a block is being filled");
2624        let reg = self.new_reg(result);
2625        let span = self.source.span(inst);
2626        let far = self.elsewhere.holds(symbol);
2627        let symbols = self.selector.symbols;
2628        match if far { symbols.far } else { symbols.near } {
2629            Reach::Mode(name) => {
2630                let mem = if far { mir::Mem::got(symbol) } else { mir::Mem::of(symbol) };
2631                let opcode = self.named(name);
2632                self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2633            }
2634            Reach::Own(name) => {
2635                let opcode = self.named(name);
2636                self.out.build(block, opcode).at(span).def(reg, self.gpr).symbol(symbol).finish();
2637            }
2638        }
2639        Ok(())
2640    }
2641
2642    /// The address of a thread-local variable, which is this thread's copy of it.
2643    ///
2644    /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2645    /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2646    /// thread and they are at different addresses, so a link asked for the distance to the name
2647    /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2648    /// the same reason.
2649    ///
2650    /// What is the same in every thread is where the variable sits inside the block of storage a
2651    /// thread gets, so that offset is what the link writes down, and the address of the running
2652    /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2653    /// front of the block, so the whole of this is three instructions:
2654    ///
2655    /// ```text
2656    /// movq  x@gottpoff(%rip), %off   # how far into the block x sits, which the link fills in
2657    /// movq  %fs:0, %tp               # where this thread's block is, which only the machine knows
2658    /// addq  %tp, %off                # this thread's copy of x
2659    /// ```
2660    ///
2661    /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2662    /// in an executable, which folds the addition into the instruction that uses the address, and
2663    /// the difference is issue #282 rather than anything about threads: nothing here folds an
2664    /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2665    /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2666    /// table slot costs nothing in the case that is common.
2667    ///
2668    /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2669    /// program is already running, and the block this reaches was laid out before it started, so
2670    /// the loader has to find room in that block for the library's variables. glibc keeps a little
2671    /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2672    /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2673    /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2674    ///
2675    /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2676    /// right for a library the program is linked against, and a load that either works or is
2677    /// refused out loud for a library something opens later. What it is never is quietly wrong.
2678    ///
2679    /// AArch64 Linux is the same three steps. The slot is reached with `adrp` and `ldr` against
2680    /// `:gottprel:`, the thread pointer is `tpidr_el0` read with `mrs`, and the add has three
2681    /// operands. Apple's platforms reach a thread-local variable through a descriptor call instead,
2682    /// which is [`Self::thread_descriptor`].
2683    fn thread_address(
2684        &mut self,
2685        inst: Inst,
2686        symbol: Symbol,
2687        result: Value,
2688    ) -> Result<(), Unsupported> {
2689        if self.elsewhere.described() {
2690            return self.thread_descriptor(inst, symbol, result);
2691        }
2692        let block = self.at.expect("a block is being filled");
2693        let span = self.source.span(inst);
2694        let gpr = self.gpr;
2695
2696        let offset = self.out.new_vreg(gpr);
2697        match self.selector.symbols.thread {
2698            Reach::Mode(name) => {
2699                let load = self.named(name);
2700                let mem = mir::Mem::thread(symbol);
2701                self.out.build(block, load).at(span).def(offset, gpr).mem(mem).finish();
2702            }
2703            Reach::Own(name) => {
2704                let load = self.named(name);
2705                self.out.build(block, load).at(span).def(offset, gpr).symbol(symbol).finish();
2706            }
2707        }
2708        let pointer = self.out.new_vreg(gpr);
2709        self.read_thread_pointer(block, span, pointer);
2710
2711        // Two address on x86-64, for the reason `x87_to_int` gives: that machine adds into the
2712        // register it read, and only the constraint says the two are the same one.
2713        let reg = self.new_reg(result);
2714        let jumps = self.selector.jumps;
2715        let add = self.named(jumps.add);
2716        let written = mir::Operand::write(reg, gpr);
2717        let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2718        self.out
2719            .build(block, add)
2720            .at(span)
2721            .operand(written)
2722            .operand(mir::Operand::read(offset, gpr))
2723            .operand(mir::Operand::read(pointer, gpr))
2724            .finish();
2725        Ok(())
2726    }
2727
2728    /// A thread-local variable on Mach-O, which is a call.
2729    ///
2730    /// The slot the machine's thread load reads holds the address of the variable's descriptor
2731    /// there, `_v@TLVP` on x86-64 and `_v@TLVPPAGE` with `_v@TLVPPAGEOFF` on AArch64. The first
2732    /// word of the descriptor is the function that finds this thread's copy, and it takes the
2733    /// descriptor's address as its one argument and gives back the copy's address. That is the
2734    /// sequence clang writes on both machines.
2735    ///
2736    /// The call is built as an ordinary call through an address, so it costs what any call costs:
2737    /// everything the convention does not preserve is taken to be gone across it. Apple's function
2738    /// keeps more than that, all but the result and the two scratch registers on AArch64, and
2739    /// taking the fewer registers as gone would be faster. What this gives up is speed, and a
2740    /// function that reads a thread-local is no longer a leaf.
2741    fn thread_descriptor(
2742        &mut self,
2743        inst: Inst,
2744        symbol: Symbol,
2745        result: Value,
2746    ) -> Result<(), Unsupported> {
2747        let block = self.at.expect("a block is being filled");
2748        let span = self.source.span(inst);
2749        let gpr = self.gpr;
2750
2751        let descriptor = self.out.new_vreg(gpr);
2752        match self.selector.symbols.thread {
2753            Reach::Mode(name) => {
2754                let load = self.named(name);
2755                let mem = mir::Mem::thread(symbol);
2756                self.out.build(block, load).at(span).def(descriptor, gpr).mem(mem).finish();
2757            }
2758            Reach::Own(name) => {
2759                let load = self.named(name);
2760                let build = self.out.build(block, load).at(span);
2761                build.def(descriptor, gpr).symbol(symbol).finish();
2762            }
2763        }
2764        let finder = self.out.new_vreg(gpr);
2765        let word = (self.selector.abi.load)(Type::PTR).ok_or_else(|| self.unsupported(inst))?;
2766        let word = mir::Opcode::new(self.names.intern(word));
2767        let mem = mir::Mem::at(mir::Operand::read(descriptor, gpr));
2768        self.out.build(block, word).at(span).def(finder, gpr).mem(mem).finish();
2769
2770        let args = [abi::Passing { ty: Type::PTR, reg: descriptor, abi: Abi::default() }];
2771        let what = abi::Calling {
2772            callee: abi::Callee::Through(finder),
2773            args: &args,
2774            returns: &[Type::PTR],
2775            variadic: false,
2776            named: 1,
2777            at: span,
2778        };
2779        let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
2780            .map_err(|refused| Unsupported::Call { inst, refused })?;
2781        let calls = &mut self.stack.calls;
2782        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
2783        let &[reg] = &made.results[..] else { return Err(self.unsupported(inst)) };
2784        self.regs[result.index()] = Some(reg);
2785        Ok(())
2786    }
2787
2788    /// Refuses the thread pointer where it is not written, which is Mach-O. Apple keeps it in a
2789    /// different register from the one Linux does on both machines, and nothing written for it
2790    /// has been checked on one.
2791    fn threads_written(&self, inst: Inst) -> Result<(), Unsupported> {
2792        if self.elsewhere.described() {
2793            return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
2794        }
2795        Ok(())
2796    }
2797
2798    /// The front of this thread's block into `reg`.
2799    ///
2800    /// On x86-64 that is the one thing no instruction can work out: `%fs` is not a register a
2801    /// program can read, and what it points at is a word holding its own address, so reading
2802    /// through it at zero is how the address is come by. AArch64 keeps it in `tpidr_el0`, which
2803    /// `mrs` reads.
2804    fn read_thread_pointer(&mut self, block: mir::Block, span: Span, reg: mir::Reg) {
2805        let gpr = self.gpr;
2806        match self.selector.symbols.pointer {
2807            Pointer::Segment(name, segment) => {
2808                let load = self.named(name);
2809                let at = mir::Mem::in_segment(segment, 0);
2810                self.out.build(block, load).at(span).def(reg, gpr).mem(at).finish();
2811            }
2812            Pointer::Own(name) => {
2813                let read = self.named(name);
2814                self.out.build(block, read).at(span).def(reg, gpr).finish();
2815            }
2816        }
2817    }
2818
2819    /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
2820    /// in this same function.
2821    ///
2822    /// What the two have in common is the whole of the instruction: an address worked out from
2823    /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
2824    /// reaches anything. What they do not have in common is what fills the four bytes in. A
2825    /// global is a name, so the number is a relocation and the linker writes it. A block is a
2826    /// place in this function, so both ends are in one section and the number is known as soon as
2827    /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
2828    /// jump rather than leaving a relocation behind.
2829    ///
2830    /// Nothing here says the block is one control can arrive at. That is said by the
2831    /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
2832    /// and by nothing else: an address on its own is a number.
2833    fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
2834        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2835        let Some(call) = self.source.successors(inst).next() else {
2836            return Err(self.unsupported(inst));
2837        };
2838        let block = self.at.expect("a block is being filled");
2839        let reg = self.new_reg(result);
2840        let span = self.source.span(inst);
2841        let opcode = self.named(self.selector.jumps.near);
2842        let mem = mir::Mem::block(self.out_block(call.block));
2843        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2844        Ok(())
2845    }
2846
2847    /// `goto *p`, GNU's computed goto, which is a jump through a register.
2848    ///
2849    /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
2850    /// block this ends, the way every other arm is, and which of them the address holds is decided
2851    /// while the program runs. So this is one instruction with one operand, and the arms are
2852    /// copied across by [`Self::edges`] like anybody else's.
2853    fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
2854        let data = &self.source[inst];
2855        let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2856        let reg = self.reg_of(address)?;
2857        let block = self.at.expect("a block is being filled");
2858        let span = self.source.span(inst);
2859        let name = self.selector.branch.indirect;
2860        let opcode = self.named(name);
2861        self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
2862        Ok(())
2863    }
2864
2865    /// A `switch` on an index from zero up, as a jump through a table of this function.
2866    ///
2867    /// Every `switch` that reaches here is one `crate::switch` left behind on purpose: it has
2868    /// already checked the value is inside the table and taken the lowest case off it, so the
2869    /// operand is a 64 bit index, the cases are the values from zero up with gaps where the
2870    /// program had no case, and the default is only where those gaps go. What is written is the
2871    /// shape gcc writes for the same statement in position independent code:
2872    ///
2873    /// ```text
2874    /// leaq    table(%rip), %base
2875    /// movslq  (%base,%index,4), %offset
2876    /// addq    %base, %offset
2877    /// jmp     *%offset
2878    /// ```
2879    ///
2880    /// The table holds distances from itself to each arm rather than addresses, which is what
2881    /// lets it be filled in by the assembler with nothing left for a linker to do. Each cell is
2882    /// stored as the place of an arm among this block's successors, which [`Self::edges`] copies
2883    /// across in the IR's own order, the default first and then one per case. See
2884    /// [`mir::Table`] for why a place and not a block.
2885    fn jump_table(&mut self, inst: Inst) -> Result<(), Unsupported> {
2886        let data = &self.source[inst];
2887        let Extra::Switch(info) = data.extra else { return Err(self.unsupported(inst)) };
2888        let &index = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2889        let ty = self.source[index].ty;
2890        if ty != Type::int(u64::BITS) {
2891            return Err(self.unsupported(inst));
2892        }
2893        let cases = self.source[self.source[info].cases].to_vec();
2894        let mut cells: Vec<u32> = Vec::new();
2895        for (arm, case) in cases.iter().enumerate() {
2896            let at = usize::try_from(case.signed(ty)).map_err(|_| self.unsupported(inst))?;
2897            if at >= cells.len() {
2898                cells.resize(at + 1, 0);
2899            }
2900            cells[at] = u32::try_from(arm + 1).map_err(|_| self.unsupported(inst))?;
2901        }
2902        let reg = self.reg_of(index)?;
2903        let block = self.at.expect("a block is being filled");
2904        let span = self.source.span(inst);
2905        let gpr = self.gpr;
2906        let table = u32::try_from(self.out.tables.len()).expect("fewer tables than that");
2907
2908        let jumps = self.selector.jumps;
2909
2910        let base = self.out.new_vreg(gpr);
2911        let near = self.named(jumps.near);
2912        self.out.build(block, near).at(span).def(base, gpr).mem(mir::Mem::table(table)).finish();
2913        let offset = self.out.new_vreg(gpr);
2914        let cell =
2915            mir::Mem::at(mir::Operand::read(base, gpr)).indexed(mir::Operand::read(reg, gpr), 4);
2916        let load = self.named(jumps.cell);
2917        self.out.build(block, load).at(span).def(offset, gpr).mem(cell).finish();
2918        // Two address on x86-64, for the reason `thread_pointer` gives.
2919        let to = self.out.new_vreg(gpr);
2920        let add = self.named(jumps.add);
2921        let written = mir::Operand::write(to, gpr);
2922        let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2923        self.out
2924            .build(block, add)
2925            .at(span)
2926            .operand(written)
2927            .operand(mir::Operand::read(offset, gpr))
2928            .operand(mir::Operand::read(base, gpr))
2929            .finish();
2930        let jump = self.named(self.selector.branch.indirect);
2931        let jump =
2932            self.out.build(block, jump).at(span).operand(mir::Operand::read(to, gpr)).finish();
2933        self.out.tables.push(mir::Table { jump, cells });
2934        Ok(())
2935    }
2936
2937    /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
2938    /// somewhere else can bring control back here, and answers zero on the way past.
2939    ///
2940    /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
2941    /// block ends: everything after the save in the IR block is put into a new machine IR block,
2942    /// and the address of that block is what went into the buffer. That is the whole reason the
2943    /// block is split here. An address points at a label, a machine IR block is the only thing in
2944    /// this representation that has one, and a save is in the middle of a block rather than at the
2945    /// end of one.
2946    ///
2947    /// # How the answer gets back
2948    ///
2949    /// Through the frame rather than through a register. The save writes a zero into a word of its
2950    /// own frame, puts the address of that word in the buffer, and the new block reads the word
2951    /// back. The restore writes a one through the address it finds in the buffer before it goes.
2952    /// So one load answers zero on the way past and one on the way back, and neither path has to
2953    /// agree with the other about a register.
2954    ///
2955    /// gcc does it the other way round, with a second block that sets the answer to one and is
2956    /// what the restore arrives at. That block is one nothing in the function jumps to, and a
2957    /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
2958    /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
2959    /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
2960    /// and it needs nothing said anywhere about a block arrived at from outside.
2961    ///
2962    /// # What the allocator is told
2963    ///
2964    /// That every register it hands out is gone at the end of the first block. That is what makes
2965    /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
2966    /// in some other function, and the only two registers that puts back are the stack pointer and
2967    /// the frame pointer, so anything this function still wants has to be in the frame those two
2968    /// reach. It is said with a write of every one of those registers, which is the same thing a
2969    /// call says about the registers a callee may destroy, on an instruction with nothing else on
2970    /// it so that the stores above are not caught up in it.
2971    fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
2972        let data = &self.source[inst];
2973        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2974        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2975        let span = self.source.span(inst);
2976        let buf = self.reg_of(buffer)?;
2977        let at = self.at.expect("a block is being filled");
2978        let gpr = self.gpr;
2979        let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
2980        let store = self.named(moves.store);
2981        let load = self.named(moves.load);
2982        let lea = self.named(self.selector.frame.lea);
2983        let put = self.named(self.selector.frame.imm);
2984        let nothing =
2985            self.selector.frame.pad.expect("a target with an instruction that does nothing");
2986        let nothing = self.named(nothing);
2987        self.stack.saves_place = true;
2988        let answer = self.answer_slot();
2989        let back = self.out.create_block();
2990
2991        // The zero this answers with, into the word a restore writes a one into.
2992        let zero = self.out.new_vreg(gpr);
2993        self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
2994        let mem = self.frame_mem();
2995        let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
2996        self.stack.addresses.push((made, answer));
2997
2998        // The four words: where that word is, where control comes back to, and the two registers
2999        // the restore puts back.
3000        let found = self.frame_address(at, answer);
3001        self.write_word(at, span, store, found, buf, JUMP_ANSWER);
3002        let pc = self.out.new_vreg(gpr);
3003        self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
3004        self.write_word(at, span, store, pc, buf, JUMP_PC);
3005        let frame = mir::Reg::physical(self.conv.frame_pointer);
3006        self.write_word(at, span, store, frame, buf, JUMP_FRAME);
3007        let stack = mir::Reg::physical(self.conv.stack_pointer);
3008        self.write_word(at, span, store, stack, buf, JUMP_STACK);
3009
3010        // Nothing is in a register past this point, which is what the rest of the function is
3011        // allowed to assume about the way back in.
3012        let gone = self.across_jump();
3013        let mut build = self.out.build(at, nothing).at(span);
3014        for (reg, class) in gone {
3015            build = build.operand(mir::Operand::write(reg, class));
3016        }
3017        build.finish();
3018
3019        // And the rest of the block, which is the block the address above was of.
3020        *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
3021        self.at = Some(back);
3022        let reg = self.new_reg(result);
3023        let mem = self.frame_mem();
3024        let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
3025        self.stack.addresses.push((made, answer));
3026        Ok(())
3027    }
3028
3029    /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
3030    ///
3031    /// Everything comes out of the buffer before anything is put back, and the four registers it
3032    /// comes out into are physical ones rather than values the allocator places. Both of those are
3033    /// about the same moment. The stack pointer is one of the things being put back, a value the
3034    /// allocator sent to the stack is reached through the stack pointer, and between the
3035    /// instruction that moves it and the jump there is no stack this function owns any more. A
3036    /// register named outright is a register nothing reloads into and nothing else is in, which is
3037    /// the only way to hold something across that moment.
3038    ///
3039    /// Four of them because that is how many things are in the air at once: where to go, the frame
3040    /// pointer to put back, the one the matching save is to answer with, and one register used
3041    /// twice, first for the address that one is written through and then for the stack pointer.
3042    ///
3043    /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
3044    /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
3045    /// written out and never run.
3046    fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
3047        let data = &self.source[inst];
3048        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3049        let span = self.source.span(inst);
3050        let buf = self.reg_of(buffer)?;
3051        let at = self.at.expect("a block is being filled");
3052        let gpr = self.gpr;
3053        let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3054        let load = self.named(moves.load);
3055        let store = self.named(moves.store);
3056        let mov = self.named(moves.mov);
3057        let put = self.named(self.selector.frame.imm);
3058        let jump = self.named(self.selector.branch.indirect);
3059
3060        let held = self.jump_regs();
3061        if held.len() < JUMP_REGS {
3062            return Err(self.unsupported(inst));
3063        }
3064        let pc = mir::Reg::physical(held[0]);
3065        let frame = mir::Reg::physical(held[1]);
3066        let spare = mir::Reg::physical(held[2]);
3067        let one = mir::Reg::physical(held[3]);
3068
3069        self.read_word(at, span, load, pc, buf, JUMP_PC);
3070        self.read_word(at, span, load, frame, buf, JUMP_FRAME);
3071        self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
3072
3073        // What the matching save answers with, written through the address that came out of the
3074        // buffer, because the word it goes in is in the other function's frame and this one has no
3075        // way of knowing where that is.
3076        self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
3077        let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
3078        self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
3079
3080        // The stack last of the four, so that the register the buffer is reached through is done
3081        // with before the stack it may have been spilled to stops being this function's.
3082        self.read_word(at, span, load, spare, buf, JUMP_STACK);
3083        let stack = mir::Reg::physical(self.conv.stack_pointer);
3084        self.copy(at, span, mov, stack, spare);
3085        let base = mir::Reg::physical(self.conv.frame_pointer);
3086        self.copy(at, span, mov, base, frame);
3087
3088        // And the jump, which reads the two registers just put back as well as the address it
3089        // goes through. Neither of those is printed, because the target's spelling of an indirect
3090        // jump has one argument and it is the first one read. They are there because the code
3091        // control arrives at reaches its frame through them, and because without them the two
3092        // instructions above write registers nothing reads: a scheduler is then free to put the
3093        // jump in front of them, and at `-O2` it does.
3094        self.out
3095            .build(at, jump)
3096            .at(span)
3097            .operand(mir::Operand::read(pc, gpr))
3098            .operand(mir::Operand::read(stack, gpr))
3099            .operand(mir::Operand::read(base, gpr))
3100            .finish();
3101        Ok(())
3102    }
3103
3104    /// One word of the buffer of a `__builtin_setjmp`, written from a register.
3105    fn write_word(
3106        &mut self,
3107        at: mir::Block,
3108        span: Span,
3109        store: mir::Opcode,
3110        from: mir::Reg,
3111        buf: mir::Reg,
3112        word: i32,
3113    ) {
3114        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3115        self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
3116    }
3117
3118    /// One word of that buffer, read back into a register.
3119    fn read_word(
3120        &mut self,
3121        at: mir::Block,
3122        span: Span,
3123        load: mir::Opcode,
3124        into: mir::Reg,
3125        buf: mir::Reg,
3126        word: i32,
3127    ) {
3128        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3129        self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
3130    }
3131
3132    /// One register into another, which is the one shape of instruction the builder has no word
3133    /// for because neither operand is a definition of a value or a read of memory.
3134    fn copy(
3135        &mut self,
3136        at: mir::Block,
3137        span: Span,
3138        mov: mir::Opcode,
3139        into: mir::Reg,
3140        from: mir::Reg,
3141    ) {
3142        self.out
3143            .build(at, mov)
3144            .at(span)
3145            .operand(mir::Operand::write(into, self.gpr))
3146            .operand(mir::Operand::read(from, self.gpr))
3147            .finish();
3148    }
3149
3150    /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
3151    fn answer_slot(&mut self) -> usize {
3152        match self.answer {
3153            Some(index) => index,
3154            None => {
3155                let index = self.stack.locals.len();
3156                self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
3157                self.answer = Some(index);
3158                index
3159            }
3160        }
3161    }
3162
3163    /// An address in this function's frame with nothing in its displacement, which is what an
3164    /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
3165    /// where the object is.
3166    fn frame_mem(&self) -> mir::Mem {
3167        mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
3168    }
3169
3170    /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
3171    ///
3172    /// Both files, since a `double` live across a save has the same problem an integer does. The
3173    /// two registers a frame is reached through are not here: the restore puts both of them back,
3174    /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
3175    /// by its own save would have nothing left to find its caller with.
3176    fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
3177        let mut gone = Vec::new();
3178        for &reg in self.conv.int_order {
3179            if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
3180                continue;
3181            }
3182            gone.push((mir::Reg::physical(reg), self.gpr));
3183        }
3184        for &reg in self.conv.sse_order {
3185            gone.push((mir::Reg::physical(reg), self.conv.sse_class));
3186        }
3187        gone
3188    }
3189
3190    /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
3191    ///
3192    /// The ones the allocator hands out, less the two a frame is reached through. The scratch
3193    /// registers are not among them on purpose: the rewriter writes a reload into one of those
3194    /// wherever it likes, and one of these has to survive from the load that fills it to the
3195    /// instruction that reads it however many instructions apart those are.
3196    fn jump_regs(&self) -> Vec<PhysReg> {
3197        self.conv
3198            .int_order
3199            .iter()
3200            .copied()
3201            .filter(|&reg| {
3202                reg != self.conv.stack_pointer
3203                    && reg != self.conv.frame_pointer
3204                    && !self.selector.scratch.contains(&reg)
3205            })
3206            .collect()
3207    }
3208
3209    /// A machine opcode of this target from the name the target gives it.
3210    fn named(&mut self, name: &str) -> mir::Opcode {
3211        mir::Opcode::new(self.names.intern(&format!("{}{name}", self.selector.prefix())))
3212    }
3213
3214    /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
3215    /// saved frame pointers and then one thing read at the end of it.
3216    ///
3217    /// Every frame that kept a frame pointer holds the caller's at the address the register points
3218    /// at, and the address that frame returns to one word above that, which is where the call
3219    /// instruction put it and where the prologue's push left it. So the walk is a load through the
3220    /// register for each link, the frame address is wherever the walk stopped, and the return
3221    /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
3222    /// x86-64 at `-O2` for depths zero to three of both builtins.
3223    ///
3224    /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
3225    /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
3226    /// needs it as the start, so there is no case here where it is not wanted.
3227    ///
3228    /// How far the chain actually reaches is the program's business and not this one's. A caller
3229    /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
3230    /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
3231    /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
3232    /// `check/builtin/frame.rs` rather than walked as far as it says.
3233    fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
3234        let data = &self.source[inst];
3235        let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
3236        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3237        let returning = data.opcode == Opcode::ReturnAddress;
3238        let block = self.at.expect("a block is being filled");
3239        let span = self.source.span(inst);
3240        let moves =
3241            self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
3242        let load = self.named(moves.load);
3243        self.stack.walks_frames = true;
3244
3245        // Where the walk is up to. The frame pointer to begin with, and the register the last load
3246        // wrote after that.
3247        let reg = self.new_reg(result);
3248        let mut base = mir::Reg::physical(self.conv.frame_pointer);
3249        for link in 0..depth {
3250            // The last load of a walk that is looking for a frame writes the answer itself, which
3251            // is what keeps a walk of so many links that many instructions and not one more.
3252            let ends_here = link + 1 == depth && !returning;
3253            let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
3254            let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
3255            self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
3256            base = next;
3257        }
3258
3259        if returning {
3260            let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
3261            let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
3262            self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
3263        } else if depth == 0 {
3264            // The one case with no load in it at all: the frame this function is running in is the
3265            // register itself, and a physical register is not one the allocator hands out, so the
3266            // answer is a copy of it.
3267            let mov = self.named(moves.mov);
3268            self.out
3269                .build(block, mov)
3270                .at(span)
3271                .operand(mir::Operand::write(reg, self.gpr))
3272                .operand(mir::Operand::read(base, self.gpr))
3273                .finish();
3274        }
3275        Ok(())
3276    }
3277
3278    /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
3279    /// an offset to.
3280    ///
3281    /// The same one instruction, on its own this time and with nothing to add to it. A program
3282    /// writes this when what it wants is a number that is different in every thread and cheap to
3283    /// come by, rather than a variable of its own in the block, so there is no relocation here and
3284    /// no name for the link to resolve.
3285    fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
3286        self.threads_written(inst)?;
3287        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3288        let block = self.at.expect("a block is being filled");
3289        let span = self.source.span(inst);
3290        let reg = self.new_reg(result);
3291        self.read_thread_pointer(block, span, reg);
3292        Ok(())
3293    }
3294
3295    /// What a named machine register holds, which is `register long x asm ("rbx");`.
3296    ///
3297    /// One move out of that register, with the register named as itself the way a register a
3298    /// template wrote is named, which is [`Self::itself`] and is the thing #1653 built. What it
3299    /// buys here is what it buys there: the register is part of the instruction the allocator
3300    /// sees, so it is a use the allocator will not have written over first, and the value goes
3301    /// into an ordinary one of its own that everything downstream reads.
3302    ///
3303    /// The whole sixty four bits are moved whatever the type is, because the register is that
3304    /// wide and a narrower type reads the low end of the copy, which is the same low end. A type
3305    /// wider than the register is refused, since there is no register holding it to read. On
3306    /// AArch64 a float may be kept in a vector register, `register double x asm ("d8");`, and it is
3307    /// moved out of that file the same way.
3308    ///
3309    /// A name the machine has not got is refused too, and is the only thing that can be wrong
3310    /// with the string: which register a name means is this machine's question and this is where
3311    /// the question is asked, at the same table `asm` asks about clobbers at. The sigil gcc
3312    /// allows in front of it is taken off here, because what the name is written with is syntax.
3313    fn register_value(&mut self, inst: Inst) -> Result<(), Unsupported> {
3314        let Extra::Symbol(symbol) = self.source[inst].extra else {
3315            return Err(self.unsupported(inst));
3316        };
3317        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3318        let ty = self.source[result].ty;
3319        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3320        if bits > ADDRESS_BITS {
3321            return Err(self.unsupported(inst));
3322        }
3323        let spelled = self.names.resolve(symbol).to_owned();
3324        let bare = spelled.strip_prefix('%').unwrap_or(&spelled);
3325        let named = if self.on_aarch64() {
3326            aarch64::named(bare)
3327        } else if self.class_of(ty) != self.gpr {
3328            return Err(self.unsupported(inst));
3329        } else {
3330            x86_64::gpr_named(bare).map(|(reg, _)| (reg, self.gpr))
3331        };
3332        let Some((held, file)) = named else {
3333            return Err(Unsupported::Register { inst, name: spelled });
3334        };
3335        // A float in a general purpose register, or a number in a vector one, is a register the
3336        // machine has holding a type that is not kept there, and would need a move between the
3337        // files that nothing here makes yet.
3338        if on_x87(ty) || self.class_of(ty) != file {
3339            return Err(self.unsupported(inst));
3340        }
3341        let block = self.at.expect("a block is being filled");
3342        let span = self.source.span(inst);
3343        let mov = self.selector.frame.moves(file).expect("a class the target says how to move").mov;
3344        let mov = self.named(mov);
3345        let into = self.new_reg(result);
3346        self.out
3347            .build(block, mov)
3348            .at(span)
3349            .operand(mir::Operand::write(into, file))
3350            .operand(
3351                mir::Operand::read(mir::Reg::physical(held), file).with(Constraint::Fixed(held)),
3352            )
3353            .finish();
3354        Ok(())
3355    }
3356
3357    /// A conversion that converts nothing: the result is the operand under another type.
3358    ///
3359    /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
3360    /// an integer as wide as the machine addresses, so a cast between the two changes what the
3361    /// type system calls the value and changes nothing about the value, and the register holding
3362    /// it is the register that already held it. The front end never writes either of them at any
3363    /// other width, because it widens or narrows around the cast rather than through it, so the
3364    /// two widths disagreeing here means the IR came from somewhere else and is refused rather
3365    /// than guessed at.
3366    ///
3367    /// Reading the operand first is what materializes it when it is a constant, which is the case
3368    /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
3369    /// register before anything can call it an address.
3370    fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
3371        let data = &self.source[inst];
3372        let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
3373        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3374        if !self.is_address_width(self.source[arg].ty)
3375            || !self.is_address_width(self.source[result].ty)
3376        {
3377            return Err(self.unsupported(inst));
3378        }
3379        let reg = self.reg_of(arg)?;
3380        self.regs[result.index()] = Some(reg);
3381        Ok(())
3382    }
3383
3384    /// One barrier, which on this machine is one instruction at the strongest ordering and no
3385    /// instruction at all at every other one.
3386    ///
3387    /// x86-64 is total store order, so the only reordering the machine does is a store followed by
3388    /// a load of a different address, and the only ordering that forbids that is sequential
3389    /// consistency. An acquire, a release and an acquire release fence are therefore already true
3390    /// of every program running here, and what a program wanted from writing one is that the
3391    /// compiler not move memory accesses across it. The optimizer has finished by the time this
3392    /// runs and nothing below reorders one access past another, so the constraint is already
3393    /// discharged and there is nothing to write.
3394    ///
3395    /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
3396    /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
3397    /// on the stack is faster on most parts and is what some compilers write instead; it is also a
3398    /// write to memory the program did not ask for, and the plain barrier is the one that says what
3399    /// it means.
3400    ///
3401    /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
3402    /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
3403    /// nothing, so there is no equality to state, and what makes it the right answer is the memory
3404    /// model, which the rule language cannot talk about.
3405    fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
3406        let Extra::Order(order) = self.source[inst].extra else {
3407            return Err(self.unsupported(inst));
3408        };
3409        // AArch64 is not total store order, so every ordering above relaxed is an instruction
3410        // there. An acquire fence only has to keep later accesses after earlier loads, which is
3411        // `dmb ishld`, and everything stronger is the full `dmb ish` gcc writes for it.
3412        let name = match order {
3413            MemOrder::NotAtomic | MemOrder::Relaxed => return Ok(()),
3414            MemOrder::Acquire if self.on_aarch64() => "fence_acquire",
3415            _ if self.on_aarch64() => self.selector.fence,
3416            MemOrder::SeqCst => self.selector.fence,
3417            _ => return Ok(()),
3418        };
3419        let block = self.at.expect("a block is being filled");
3420        let span = self.source.span(inst);
3421        let fence = self.named(name);
3422        self.out.build(block, fence).at(span).finish();
3423        Ok(())
3424    }
3425
3426    /// The instruction a program stops on, which is one byte pair and no operands.
3427    ///
3428    /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
3429    /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
3430    /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
3431    /// caught by anything the program installed for an ordinary error, cannot be returned from,
3432    /// and leaves the address of the fault in the core file.
3433    ///
3434    /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
3435    /// library, and it works in the places this one is written most, which are a kernel and a
3436    /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
3437    fn trap(&mut self, inst: Inst) {
3438        let block = self.at.expect("a block is being filled");
3439        let span = self.source.span(inst);
3440        let stop = self.named(self.selector.trap);
3441        self.out.build(block, stop).at(span).finish();
3442    }
3443
3444    /// One hint that an address is about to be used, which is one instruction and no promise.
3445    ///
3446    /// Four instructions on this machine and the locality picks between them, which is what the
3447    /// number means: how much of the data will still be wanted after the access. None of it wanted
3448    /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
3449    /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
3450    /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
3451    /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
3452    ///
3453    /// Whether the access will write is not read on x86-64, and that is the machine rather than an
3454    /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
3455    /// writes it only when the command line said the part has it. So a prefetch for a write is the
3456    /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
3457    /// `-mprfchw`. AArch64 has it in the base set, so there a write picks the four `pst` forms of
3458    /// `prfm` in place of the `pld` ones, at the same levels.
3459    ///
3460    /// The address goes in the addressing mode rather than in an operand, the way a store's does.
3461    /// It is built here as the plainest one there is, a register and nothing else, because what
3462    /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
3463    /// this instruction. An address the program computed is therefore one `lea` or one add in front
3464    /// of this, which is what it would have been for the load the hint is about anyway.
3465    fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
3466        let Extra::Prefetch(hint) = self.source[inst].extra else {
3467            return Err(self.unsupported(inst));
3468        };
3469        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3470        let [address] = args[..] else { return Err(self.unsupported(inst)) };
3471        // AArch64 has the write hint in the base instruction set, and gcc 16.2.0 writes it there.
3472        let write = hint.write && self.on_aarch64();
3473        let name = match (hint.locality, write) {
3474            (0, false) => "prefetch_nta",
3475            (1, false) => "prefetch_t2",
3476            (2, false) => "prefetch_t1",
3477            (PrefetchHint::MOST, false) => "prefetch_t0",
3478            (0, true) => "prefetch_w_nta",
3479            (1, true) => "prefetch_w_t2",
3480            (2, true) => "prefetch_w_t1",
3481            (PrefetchHint::MOST, true) => "prefetch_w_t0",
3482            // Nothing else exists. The checker reads a locality outside the range as zero and the
3483            // verifier refuses one that got here another way, so this is a hint that was built
3484            // rather than checked, and the safe answer for a hint is to write no instruction.
3485            _ => return Err(self.unsupported(inst)),
3486        };
3487        let base = self.reg_of(address)?;
3488        let block = self.at.expect("a block is being filled");
3489        let opcode = self.named(name);
3490        self.out
3491            .build(block, opcode)
3492            .at(self.source.span(inst))
3493            .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
3494            .finish();
3495        Ok(())
3496    }
3497
3498    /// One compare and exchange, which is the instruction every other atomic on this machine is
3499    /// built out of.
3500    ///
3501    /// What the IR asks for is: read what is at an address, compare it against a value the program
3502    /// expected, put a second value there if the two were equal, and say both what was read and
3503    /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
3504    /// front of it is what makes the whole of it one step as far as every other processor is
3505    /// concerned.
3506    ///
3507    /// The ordering is not read here, and that is the memory model rather than an omission. A
3508    /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
3509    /// compare and exchange and a sequentially consistent one are the same instruction, and there
3510    /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
3511    /// same reason.
3512    ///
3513    /// The two values it produces are why this is written by name. The one the program compares
3514    /// against and the one it gets back are both `rax`, which the instruction reads and writes
3515    /// without being told, and the table says so with a fixed constraint at each end rather than
3516    /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
3517    /// flag read out by a `sete`, and it is a definition of the same instruction so that the
3518    /// allocator knows the two are live together and never gives the byte the register the answer
3519    /// is in.
3520    fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
3521        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3522        let results: Vec<Value> = self.source[inst].results().collect();
3523        let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
3524        let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
3525        if self.on_aarch64() {
3526            return self.exchange_a64(inst, [addr, expected, desired], [old, exchanged]);
3527        }
3528
3529        // A value the machine can compare in one instruction, which is an integer or an address at
3530        // one of the four widths it has a compare and exchange for. Anything else is a type this
3531        // has no instruction for rather than a program that is wrong, and the front end refuses it
3532        // before ever getting here.
3533        let ty = self.source[old].ty;
3534        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3535        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3536            return Err(self.unsupported(inst));
3537        }
3538
3539        let base = self.reg_of(addr)?;
3540        let want = self.reg_of(expected)?;
3541        let put = self.reg_of(desired)?;
3542        let got = self.new_reg(old);
3543        let flag = self.new_reg(exchanged);
3544
3545        let name = format!("cmpxchg_{bits}");
3546        let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3547        let block = self.at.expect("a block is being filled");
3548        let opcode = self.named(&name);
3549        let (span, flags) = (self.source.span(inst), self.carried(inst));
3550        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3551        for (desc, reg) in descs.iter().zip([got, flag, want, put]) {
3552            let operand = mir::Operand {
3553                reg,
3554                class: desc.class,
3555                role: desc.role,
3556                constraint: desc.constraint,
3557            };
3558            build = build.operand(operand);
3559        }
3560        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3561        Ok(())
3562    }
3563
3564    /// One read modify write, for the three operations this machine does in a single instruction.
3565    ///
3566    /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
3567    /// say what was there before, and let nothing get between the three steps. The machine has
3568    /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
3569    /// found in the register the operand arrived in, which is why the value that comes back and the
3570    /// value that went in are one register here.
3571    ///
3572    /// A subtraction is the add over the negated operand, which is right at every width because the
3573    /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
3574    /// whatever the operands were. The negate is a separate instruction in front, over a register of
3575    /// its own, so that the value the program handed over is not the one written on: an operand may
3576    /// be live after this and a program that read it again would read the negation.
3577    ///
3578    /// The ordering is not read, for the reason the compare and exchange beside this does not read
3579    /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
3580    /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
3581    ///
3582    /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
3583    /// around a compare and exchange before anything here saw it. The two that do arrive are the
3584    /// ones on floating values, and they are refused: a compare and exchange of a float wants the
3585    /// value carried through an integer of the same width, and an eighty bit float has no such
3586    /// width. Neither family of builtins can write one yet either, so a program that reaches this
3587    /// refusal is a program that reached an unimplemented builtin first.
3588    fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
3589        let Extra::Rmw(op, _) = self.source[inst].extra else {
3590            return Err(self.unsupported(inst));
3591        };
3592        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3593        let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
3594        let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3595
3596        // A value the machine can exchange in one instruction, which is an integer at one of the
3597        // four widths it has these for. A pointer arrives as an address, so it is an integer by the
3598        // time it is here, and anything else is a type this has no instruction for.
3599        let ty = self.source[old].ty;
3600        if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3601            return Err(self.unsupported(inst));
3602        }
3603        if self.on_aarch64() {
3604            return self.modify_a64(inst, op, [addr, operand], old);
3605        }
3606        let name = match op {
3607            RmwOp::Xchg => format!("xchg_{}", ty.bits()),
3608            RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
3609            _ => return Err(self.unsupported(inst)),
3610        };
3611
3612        let base = self.reg_of(addr)?;
3613        let mut put = self.reg_of(operand)?;
3614        let block = self.at.expect("a block is being filled");
3615        let span = self.source.span(inst);
3616        if op == RmwOp::Sub {
3617            let negated = self.out.new_vreg(self.gpr);
3618            let negate = self.named(&format!("neg_r_{}", ty.bits()));
3619            let descs = self
3620                .selector
3621                .operands(&format!("neg_r_{}", ty.bits()))
3622                .ok_or_else(|| self.unsupported(inst))?;
3623            let mut build = self.out.build(block, negate).at(span);
3624            for (desc, reg) in descs.iter().zip([negated, put]) {
3625                build = build.operand(mir::Operand {
3626                    reg,
3627                    class: desc.class,
3628                    role: desc.role,
3629                    constraint: desc.constraint,
3630                });
3631            }
3632            build.finish();
3633            put = negated;
3634        }
3635
3636        let got = self.new_reg(old);
3637        let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3638        let opcode = self.named(&name);
3639        let flags = self.carried(inst);
3640        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3641        for (desc, reg) in descs.iter().zip([got, put]) {
3642            build = build.operand(mir::Operand {
3643                reg,
3644                class: desc.class,
3645                role: desc.role,
3646                constraint: desc.constraint,
3647            });
3648        }
3649        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3650        Ok(())
3651    }
3652
3653    /// The width an AArch64 atomic works at, which is an integer or an address of one of the four
3654    /// widths the exclusive loads and stores have. Anything else is refused.
3655    fn atomic_bits(&self, inst: Inst, ty: Type) -> Result<u32, Unsupported> {
3656        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3657        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3658            return Err(self.unsupported(inst));
3659        }
3660        Ok(bits)
3661    }
3662
3663    /// One instruction by name, with its operands in the order the table lists them.
3664    fn written_as(&mut self, inst: Inst, name: &str, regs: &[mir::Reg]) -> Result<(), Unsupported> {
3665        let descs = self.selector.operands(name).ok_or_else(|| self.unsupported(inst))?;
3666        if descs.len() != regs.len() {
3667            return Err(self.unsupported(inst));
3668        }
3669        let block = self.at.expect("a block is being filled");
3670        let opcode = self.named(name);
3671        let (span, flags) = (self.source.span(inst), self.carried(inst));
3672        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3673        for (desc, &reg) in descs.iter().zip(regs) {
3674            build = build.operand(mir::Operand {
3675                reg,
3676                class: desc.class,
3677                role: desc.role,
3678                constraint: desc.constraint,
3679            });
3680        }
3681        build.finish();
3682        Ok(())
3683    }
3684
3685    /// An acquiring load or a releasing store on AArch64, which is `ldar` or `stlr`.
3686    ///
3687    /// Only a relaxed access became the plain one above this, so what arrives is acquire or
3688    /// stronger for a load and release or stronger for a store. `ldar` and `stlr` are also
3689    /// sequentially consistent with each other, which is why the strongest ordering needs no fence
3690    /// on either side, and is what gcc 16.2.0 writes for all of them.
3691    fn ordered(&mut self, inst: Inst) -> Result<(), Unsupported> {
3692        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3693        if self.source[inst].opcode == Opcode::AtomicLoad {
3694            let [addr] = args[..] else { return Err(self.unsupported(inst)) };
3695            let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3696            let bits = self.atomic_bits(inst, self.source[result].ty)?;
3697            let base = self.reg_of(addr)?;
3698            let got = self.new_reg(result);
3699            return self.written_as(inst, &format!("ldar_{bits}"), &[got, base]);
3700        }
3701        let [value, addr] = args[..] else { return Err(self.unsupported(inst)) };
3702        let bits = self.atomic_bits(inst, self.source[value].ty)?;
3703        let put = self.reg_of(value)?;
3704        let base = self.reg_of(addr)?;
3705        self.written_as(inst, &format!("stlr_{bits}"), &[put, base])
3706    }
3707
3708    /// A compare and exchange on AArch64, which is a loop of an exclusive load and store.
3709    ///
3710    /// The loop is one instruction as far as everything below is concerned, so that nothing can
3711    /// be spilled or reloaded between the two exclusive accesses, which would lose the reservation
3712    /// on some parts every time. Its definitions are all early, since they are written before the
3713    /// last read. The acquiring and releasing forms are used whatever the ordering, which is what
3714    /// gcc writes at the strongest one and is never wrong at a weaker one. The yes or no comes out
3715    /// of the status register the store wrote, read as a flag after the loop.
3716    fn exchange_a64(
3717        &mut self,
3718        inst: Inst,
3719        [addr, expected, desired]: [Value; 3],
3720        [old, exchanged]: [Value; 2],
3721    ) -> Result<(), Unsupported> {
3722        let bits = self.atomic_bits(inst, self.source[old].ty)?;
3723        let base = self.reg_of(addr)?;
3724        let want = self.reg_of(expected)?;
3725        let put = self.reg_of(desired)?;
3726        let got = self.new_reg(old);
3727        let flag = self.new_reg(exchanged);
3728        self.written_as(inst, &format!("cmpxchg_{bits}"), &[got, flag, base, want, put])
3729    }
3730
3731    /// A read modify write on AArch64, for the three operations that reach here, each a loop of
3732    /// an exclusive load and store for the reason the compare and exchange above is.
3733    fn modify_a64(
3734        &mut self,
3735        inst: Inst,
3736        op: RmwOp,
3737        [addr, operand]: [Value; 2],
3738        old: Value,
3739    ) -> Result<(), Unsupported> {
3740        let bits = self.atomic_bits(inst, self.source[old].ty)?;
3741        let base = self.reg_of(addr)?;
3742        let put = self.reg_of(operand)?;
3743        let got = self.new_reg(old);
3744        let status = self.out.new_vreg(self.gpr);
3745        match op {
3746            RmwOp::Xchg => {
3747                self.written_as(inst, &format!("xchg_{bits}"), &[got, status, base, put])
3748            }
3749            RmwOp::Add | RmwOp::Sub => {
3750                let name = if op == RmwOp::Add { "xadd" } else { "xsub" };
3751                let new = self.out.new_vreg(self.gpr);
3752                self.written_as(inst, &format!("{name}_{bits}"), &[got, new, status, base, put])
3753            }
3754            _ => Err(self.unsupported(inst)),
3755        }
3756    }
3757
3758    /// One `asm` statement.
3759    ///
3760    /// An empty template is most of the inline assembly in a test suite, and it is not a corner
3761    /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
3762    /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
3763    /// years of bug reports about optimizers are full of them. What such a statement asks for is
3764    /// the barrier and the operand places, and no instructions at all.
3765    ///
3766    /// So the operands are the half that is always real: a constraint says where a value has to be,
3767    /// and where it has to be is still true when the template between them is empty.
3768    ///
3769    /// What the constraints ask for, on an empty template, is only ever that two operands share a
3770    /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
3771    /// no particular one, and any register at all answers it. A matching constraint is different,
3772    /// because it says the output the assembly leaves is the place the input arrived in, and with
3773    /// no instructions between them that is the input unchanged. So it is a rename and not a move:
3774    /// the value is already in a register and the result is that register.
3775    ///
3776    /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
3777    /// which for a template that writes nothing is whatever was in the register. That is a value
3778    /// the program is not entitled to, and this writes a zero rather than reading one, because the
3779    /// allocator has to be given a definition before a use whatever the program is entitled to.
3780    ///
3781    /// # A template with instructions in it
3782    ///
3783    /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
3784    /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
3785    /// instruction a program wrote is looked up in that description rather than copied through to
3786    /// an assembler that has one of its own. So nothing here assembles anything. What it does is
3787    /// put the statement's operands where the opcode holds them, and from there an `asm` statement
3788    /// is ordinary machine code: the allocator picks the registers, the listing and the object file
3789    /// are written from the same table as every other instruction, and a spill around one works
3790    /// because there is nothing left about it for a spill to get wrong.
3791    ///
3792    /// A register the template named in its own text is the one thing in there that is nobody's
3793    /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
3794    /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
3795    ///
3796    /// Two things are refused, both for one reason, which is that placing them by a guess gives a
3797    /// program that assembles into something other than what it says.
3798    ///
3799    /// An output the template writes more than once, which is one place with two definitions in it,
3800    /// and the machine IR between here and the allocator has one definition per register by
3801    /// construction. An output tied to an input and written once is not that: it is two registers
3802    /// the description ties together, which is what [`Place`] is about.
3803    ///
3804    /// An operand read where the opcode writes, or written where it reads. An output that has not
3805    /// been written yet is not a value, and an input the assembly writes over is a value something
3806    /// else may still be using.
3807    ///
3808    /// # A register the instruction uses without being told
3809    ///
3810    /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
3811    /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
3812    /// registers. The description holds every bit of that already, so what is left is to say which
3813    /// of the statement's operands is in each of those registers, and the constraint letter is the
3814    /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
3815    /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
3816    /// and has no choice about it.
3817    ///
3818    /// A register no letter named is one the statement put nothing in, and that is the usual case
3819    /// rather than an unusual one, since an instruction that answers four questions is written by
3820    /// programs that asked one. A write of one is the register being destroyed and gets a register
3821    /// of its own, which is what tells the allocator to keep everything else out of it. A read of
3822    /// one is a register the instruction looks at and the program never filled, which gets a zero
3823    /// for the reason [`Self::undefined`] gives.
3824    ///
3825    /// # The clobber list
3826    ///
3827    /// Read now, as the registers it names being written by every instruction of the template. By
3828    /// every one rather than by one of them, because the list says the assembly as a whole leaves
3829    /// them ruined and nothing here knows which line did it. Every entry has to be a register this
3830    /// machine has a name for or the statement is refused, since a name nobody read is a register
3831    /// nobody is keeping out of.
3832    ///
3833    /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
3834    /// says the assembly touches storage, which is already true of every `asm` this writes and is
3835    /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
3836    /// tracking already has that from the instructions the template was read into, since it takes
3837    /// every instruction it does not recognize as writing them and every instruction here is one
3838    /// this machine describes. `flags` is the name gcc's own register table gives the same thing on
3839    /// this machine, so a program writing it has written `cc` and is read that way: tcc's
3840    /// `tests/tcctest.c` lists both on one statement.
3841    ///
3842    /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
3843    /// by description, and a statement listing three of them as clobbers as well is saying the
3844    /// same thing twice, which the allocator would read as one register with two definitions.
3845    ///
3846    /// On a template with nothing in it the list is ignored, as it was before, since a template
3847    /// with no instructions ruins nothing whatever it said about what it ruins.
3848    fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
3849        let data = &self.source[inst];
3850        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
3851        let info = self.source[asm];
3852        if self.jumps_from_text(inst) {
3853            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
3854        }
3855        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3856
3857        let constraints = self.names.resolve(info.constraints).to_string();
3858        let results: Vec<Value> = data.results().collect();
3859        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
3860            .ok_or_else(refused)?;
3861        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
3862
3863        // Read after the constraints and not before them, because a mnemonic whose suffix the
3864        // program left off is read at the width of the operands it names, and the operands are
3865        // what the constraints are a list of.
3866        let widths: Vec<Option<x86_64::Width>> = list
3867            .iter()
3868            .map(|operand| {
3869                let ty = self.source[operand.result.or(operand.value)?].ty;
3870                if !ty.is_scalar() {
3871                    return None;
3872                }
3873                x86_64::Width::of_bits(held_bits(ty))
3874            })
3875            .collect();
3876        // An operand in memory is an address the statement holds and an object the template names,
3877        // so the reader is told which ones those are and spells `%0` for one as the object.
3878        let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
3879        let template = self.names.resolve(info.template).to_string();
3880        let steps = if template.trim().is_empty() {
3881            Vec::new()
3882        } else {
3883            match x86_64::read_in(&template, &widths, &memory) {
3884                Some(steps) => steps,
3885                None => return self.kept(inst, &template, &list, &widths, &memory),
3886            }
3887        };
3888
3889        // Which operands the template writes, counted before anything is placed, because the answer
3890        // decides where each of the three below comes from and one instruction may name an operand
3891        // that a later one writes. Which of them any instruction puts in a register at all is
3892        // counted in the same walk, since an operand no instruction reaches that way is one nothing
3893        // has to put anywhere: a constant a template names only as the distance into an address is
3894        // written into the instruction, and a register holding a copy of it would be one nobody
3895        // reads. An operand the address is counted from is reached that way and is counted here for
3896        // that reason, because the walk below it is over the opcode's operands and an address is
3897        // not one of those.
3898        //
3899        // Whether any instruction reads an operand an instruction above it wrote is counted in the
3900        // same walk too. Such a template is one whose instructions have to be written in order with
3901        // each read taken from wherever the last write left the operand, which is what
3902        // [`Self::woven`] does, and so is one that writes an operand twice.
3903        let mut writes = vec![0usize; list.len()];
3904        let mut reads = vec![false; list.len()];
3905        let mut held = vec![false; list.len()];
3906        let mut after = false;
3907        for step in &steps {
3908            // A call out of the template writes every register the convention lets the callee
3909            // leave anything in, and an output pinned to one of those is written by it.
3910            if let x86_64::Step::Call { .. } = step {
3911                for index in self.lost(&list).into_iter().filter_map(|(_, _, index)| index) {
3912                    *writes.get_mut(index).ok_or_else(refused)? += 1;
3913                }
3914                continue;
3915            }
3916            let x86_64::Step::Line(line) = step else { continue };
3917            match line.at.and_then(|at| at.base) {
3918                Some(x86_64::Piece::Operand { index, .. }) => {
3919                    *held.get_mut(index).ok_or_else(refused)? = true;
3920                    after |= writes[index] > 0;
3921                }
3922                Some(x86_64::Piece::Reg { reg, .. }) => {
3923                    if let Some(index) = bound(&list, reg, Role::Use) {
3924                        *held.get_mut(index).ok_or_else(refused)? = true;
3925                        after |= writes[index] > 0;
3926                    }
3927                }
3928                _ => {}
3929            }
3930            let mut written = Vec::new();
3931            let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3932            // Which registers the instruction reaches, asked the same way it is asked again when
3933            // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
3934            // comes from the constraint letters rather than from the description.
3935            let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
3936            let (described, pieces) = match &lettered {
3937                Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3938                None => (form.operands(), line.operands.as_slice()),
3939            };
3940            for (desc, piece) in described.iter().zip(pieces) {
3941                // An operand the instruction reaches without its text saying so is the statement's
3942                // only when a constraint letter put something there. One that is nobody's writes
3943                // nothing of the program's, so it is counted nowhere and is dealt with where it is
3944                // placed.
3945                let index = match *piece {
3946                    x86_64::Piece::Operand { index, .. } => index,
3947                    x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
3948                        Some(index) => index,
3949                        None => continue,
3950                    },
3951                    x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
3952                        Some(index) => index,
3953                        None => continue,
3954                    },
3955                };
3956                *held.get_mut(index).ok_or_else(refused)? = true;
3957                if matches!(desc.role, Role::Def | Role::EarlyDef) {
3958                    written.push(index);
3959                } else {
3960                    *reads.get_mut(index).ok_or_else(refused)? = true;
3961                    after |= writes[index] > 0;
3962                }
3963            }
3964            for index in written {
3965                *writes.get_mut(index).ok_or_else(refused)? += 1;
3966            }
3967        }
3968        let woven = after
3969            || writes.iter().any(|&count| count > 1)
3970            || steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_)));
3971
3972        // Where every operand is. Worked out in full before the first instruction is written, since
3973        // reading a value may be what puts it in a register in the first place, and that has to
3974        // happen in front of the assembly rather than in the middle of it.
3975        let mut places: Vec<Place> = vec![Place::default(); list.len()];
3976        for (index, operand) in list.iter().copied().enumerate() {
3977            let Some(result) = operand.result else {
3978                // An input, or an output the assembly was handed the address of, and both are a
3979                // value that arrives in a register and is read out of it, unless no instruction of
3980                // the template reads it out of one.
3981                let value = operand.value.ok_or_else(refused)?;
3982                if held[index] {
3983                    places[index].read = Some(self.reg_of(value)?);
3984                }
3985                continue;
3986            };
3987            let ty = self.source[result].ty;
3988            if on_x87(ty) {
3989                return Err(refused());
3990            }
3991            let tied = operands.tied_to(index);
3992            if let Some(from) = tied {
3993                if self.class_of(self.source[from].ty) != self.class_of(ty) {
3994                    return Err(refused());
3995                }
3996                places[index].read = Some(self.reg_of(from)?);
3997            }
3998            if writes[index] > 0 {
3999                places[index].write = Some(self.new_reg(result));
4000                continue;
4001            }
4002            match tied {
4003                // The place the input arrived in, which the assembly wrote nothing over. One
4004                // register, so this is a rename rather than a move.
4005                Some(_) => {
4006                    let reg = places[index].read.ok_or_else(refused)?;
4007                    self.regs[result.index()] = Some(reg);
4008                    places[index].write = Some(reg);
4009                }
4010                None => {
4011                    self.undefined(inst, result)?;
4012                    places[index].write = self.regs[result.index()];
4013                }
4014            }
4015        }
4016
4017        // An output an instruction of the template also reads, which the statement said nothing
4018        // about because an output is what a statement says the other thing about. What it holds
4019        // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
4020        // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
4021        // than for the number, so whatever the register held, the answer is the same. Undefined is
4022        // not the same as absent though, since the allocator is owed a definition in front of every
4023        // use, so it gets the zero an output nothing wrote gets and for the same reason.
4024        //
4025        // Unless an input could have been in the same register, in which case gcc's allocator puts
4026        // it there whenever it can and a program may have been written against that. tcc's test of
4027        // a call from a template reads its output `"=a" (s)` to pass `"r" (str)` to `getenv`, which
4028        // is only the string because gcc gave the two of them `rax`. So an output nothing has
4029        // written yet reads the one input that could share its place, when there is exactly one.
4030        // One written `&` is written before the inputs are read and shares nothing.
4031        for index in 0..list.len() {
4032            if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
4033                continue;
4034            }
4035            let reg = match self.shared(&list, index) {
4036                Some(value) => self.reg_of(value)?,
4037                None => self.seeded(inst, list[index])?,
4038            };
4039            places[index].read = Some(reg);
4040        }
4041
4042        // Worked out once for the whole template, since the list is one list and every instruction
4043        // of the template gets it. Not worked out at all for a template with no instructions, which
4044        // is where there is nothing for it to go on.
4045        let clobbers = self.names.resolve(info.clobbers).to_string();
4046        let clobbered =
4047            if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
4048
4049        // A template with a label in it is not one run of instructions, and what it is instead is
4050        // in [`Self::woven`], which is also where a template goes whose instructions read what the
4051        // ones above them wrote. Every other template is what it has always been, which is every
4052        // instruction of it written into the block the statement stands in.
4053        if woven {
4054            return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
4055        }
4056        for step in &steps {
4057            let x86_64::Step::Line(line) = step else { continue };
4058            self.instruction(inst, line, &places, &list, &clobbered)?;
4059        }
4060        Ok(())
4061    }
4062
4063    /// A template the reader could not take apart, kept as its text. See [`x86_64::Form::Template`].
4064    ///
4065    /// What the text names is spelled into it here, the way gcc prints it into its listing: a
4066    /// constant as `$5`, or as `5` under the `c` modifier, and the address of a name as the name.
4067    /// An object in memory is the one thing that cannot be spelled yet, since where it is depends on
4068    /// registers nothing has chosen, so it is left as a hole the writer fills and its address is the
4069    /// instruction's memory operand. One is all an instruction has room for, and every template this
4070    /// has met names one at most. A template that names an operand by name rather than by number is
4071    /// refused for now.
4072    ///
4073    /// # An operand in a register
4074    ///
4075    /// Which register is not known until the allocator has run, and the text is written down before
4076    /// then, so an operand in a register is a hole too. It names the instruction's own operand and
4077    /// the width the modifier asked for, or the width of the operand's type when there was none,
4078    /// and the writer spells whatever register the operand ended up in. What the text writes goes
4079    /// in first as definitions and what it reads goes in last as uses, with the registers below in
4080    /// between, so the allocator sees the statement as one instruction with every operand said. An
4081    /// output tied to an input, by `+` or by a number, reuses the input's register, and one written
4082    /// `&` is written early. Anything wider than a general purpose register is refused.
4083    ///
4084    /// A statement written with no colons is basic assembly, where `%` is a character like any
4085    /// other and a register is written `%eax`. The front end keeps no mark of which kind a statement
4086    /// was, so one with no operands and no clobbers is read as basic, which is what gcc would do for
4087    /// every such template but one written with empty colons around it.
4088    ///
4089    /// The registers a call may write are taken as written, see below for why.
4090    fn kept(
4091        &mut self,
4092        inst: Inst,
4093        template: &str,
4094        list: &[AsmOperand<'_>],
4095        widths: &[Option<x86_64::Width>],
4096        memory: &[bool],
4097    ) -> Result<(), Unsupported> {
4098        // Refused as the template it is, since keeping it is what was tried after reading it
4099        // failed, and what could not be kept is what it names rather than any one operand.
4100        let refused = || Unsupported::Assembly { inst, refused: Written::Template };
4101        let data = &self.source[inst];
4102        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4103        let clobbers = self.names.resolve(self.source[asm].clobbers).to_string();
4104        let basic = list.is_empty() && clobbers.trim().is_empty();
4105
4106        // Every register a call may leave anything in, as well as the ones the list names. The
4107        // text can write any register it likes without saying so, and tcc's tests do: gcc gets
4108        // away with that at `-O0` because nothing lives in a register between two statements
4109        // there, and taking these away from the allocator across the template is what gives the
4110        // same answer here. Nothing is written to them by this, so a register one template leaves
4111        // a value in is still holding it when the next template reads it.
4112        let a64 = self.on_aarch64();
4113        let mut clobbered: Vec<(PhysReg, RegClass)> =
4114            self.lost(list).into_iter().map(|(reg, class, _)| (reg, class)).collect();
4115        let named = if a64 {
4116            Self::clobbered_a64(inst, &clobbers)?
4117        } else {
4118            Self::clobbered(inst, &clobbers)?.into_iter().map(|reg| (reg, self.gpr)).collect()
4119        };
4120        for &(reg, class) in &named {
4121            if !clobbered.iter().any(|&(had, of)| had == reg && of == class) {
4122                clobbered.push((reg, class));
4123            }
4124        }
4125
4126        // The file each operand is in. On AArch64 `w` is a floating point or vector register and an
4127        // input tied to an output is in that output's file. A value whose type puts it in the other
4128        // file would need a move into this one first, which gcc makes and this does not yet, so
4129        // that is refused below.
4130        let mut files = vec![self.gpr; list.len()];
4131        if a64 {
4132            let constraints = self.names.resolve(self.source[asm].constraints);
4133            for (file, entry) in files.iter_mut().zip(constraints.split(',')) {
4134                if vector_letter(entry) {
4135                    *file = self.conv.sse_class;
4136                }
4137            }
4138            for index in 0..list.len() {
4139                if let Some(&file) = list[index].tied.and_then(|output| files.get(output)) {
4140                    files[index] = file;
4141                }
4142            }
4143        }
4144        let pins: Vec<_> = list.iter().map(|operand| self.pinned_here(operand)).collect();
4145        let pin = |index: usize, file: RegClass| match pins[index] {
4146            Some((at, class)) if class == file => Ok(Some(Constraint::Fixed(at))),
4147            Some(_) => Err(refused()),
4148            None => Ok(None),
4149        };
4150
4151        // The operands in a register, as the instruction's own. An input the text is handed as a
4152        // constant or as the address of a name is spelled into the text instead, when its
4153        // constraint allows a constant at all and no output is tied to it. `"a" (0x1234)` is a
4154        // register holding the number, the way gcc loads it, since the text may ask for `%h0`.
4155        let mut defs: Vec<mir::Operand> = Vec::new();
4156        let mut uses: Vec<mir::Operand> = Vec::new();
4157        let mut def_of: Vec<Option<usize>> = vec![None; list.len()];
4158        let mut use_of: Vec<Option<usize>> = vec![None; list.len()];
4159        if !basic {
4160            for (index, operand) in list.iter().enumerate() {
4161                let Some(result) = operand.result else { continue };
4162                let (ty, file) = (self.source[result].ty, files[index]);
4163                if on_x87(ty) || self.class_of(ty) != file {
4164                    return Err(refused());
4165                }
4166                let reg = self.new_reg(result);
4167                let written = if operand.early {
4168                    mir::Operand::write_early(reg, file)
4169                } else {
4170                    mir::Operand::write(reg, file)
4171                };
4172                def_of[index] = Some(defs.len());
4173                defs.push(match pin(index, file)? {
4174                    Some(fixed) => written.with(fixed),
4175                    None => written,
4176                });
4177            }
4178            for (index, operand) in list.iter().enumerate() {
4179                let Some(value) = operand.value else { continue };
4180                let spelled = operand.result.is_none()
4181                    && operand.tied.is_none()
4182                    && operand.immediate
4183                    && (self.number(value).is_some() || self.named_address(value).is_some());
4184                // An operand in memory is spelled on AArch64 as the register its address is in,
4185                // which is `[x3]` and is an address every instruction that takes one reads.
4186                if (operand.memory && !a64) || spelled {
4187                    continue;
4188                }
4189                let (ty, file) = (self.source[value].ty, files[index]);
4190                if on_x87(ty) || self.class_of(ty) != file {
4191                    return Err(refused());
4192                }
4193                let read = mir::Operand::read(self.reg_of(value)?, file);
4194                use_of[index] = Some(uses.len());
4195                uses.push(match pin(index, file)? {
4196                    Some(fixed) => read.with(fixed),
4197                    None => read,
4198                });
4199            }
4200        }
4201        // Every register a call may write is more than a template can give up when it has more
4202        // operands in registers than the convention keeps across a call. `sodium_sub` in
4203        // libsodium's `utils.c` is one: eight outputs written early and two inputs pinned, against
4204        // the five registers SysV preserves, so an output has nowhere to go and nothing is left to
4205        // carry one to its slot either. gcc gives that template ten registers, and a program that
4206        // writes a register it did not name is only owed what gcc would have done, which here is
4207        // one of the ten. So the registers taken as written without being named are handed back,
4208        // from the end of the convention's order, until the operands fit in what is left. One the
4209        // list names or an operand is pinned to stays where it is.
4210        let fixed_to: Vec<PhysReg> = defs
4211            .iter()
4212            .chain(&uses)
4213            .filter_map(|operand| match operand.constraint {
4214                Constraint::Fixed(at) => Some(at),
4215                _ => None,
4216            })
4217            .collect();
4218        let wanted = defs.iter().chain(&uses).count() - fixed_to.len();
4219        let int = self.conv.int_class;
4220        let free = |clobbered: &[(PhysReg, RegClass)]| {
4221            self.conv
4222                .int_order
4223                .iter()
4224                .filter(|&&reg| !fixed_to.contains(&reg) && !clobbered.contains(&(reg, int)))
4225                .count()
4226        };
4227        while free(&clobbered) < wanted {
4228            let Some(at) = clobbered.iter().rposition(|&(reg, class)| {
4229                class == int && !named.contains(&(reg, class)) && !fixed_to.contains(&reg)
4230            }) else {
4231                break;
4232            };
4233            clobbered.remove(at);
4234        }
4235
4236        // A register an output is pinned to is that output's definition and not a clobber as well.
4237        // One an input is pinned to is written as the instruction finishes, the way a call writes
4238        // the register its argument came in, and every other one is written early, since the text
4239        // may write it before it has read its inputs and an input must not be in it.
4240        let mut written: Vec<mir::Operand> = Vec::new();
4241        for (reg, class) in clobbered {
4242            let fixed = |operand: &mir::Operand| {
4243                operand.class == class && operand.constraint == Constraint::Fixed(reg)
4244            };
4245            if defs.iter().any(fixed) {
4246                continue;
4247            }
4248            let reg = mir::Reg::physical(reg);
4249            written.push(if uses.iter().any(fixed) {
4250                mir::Operand::write(reg, class)
4251            } else {
4252                mir::Operand::write_early(reg, class)
4253            });
4254        }
4255        // An output tied to an input is one register, which the definition says by reusing the
4256        // use, or by both being fixed to the same one when the output was pinned.
4257        let first_use = defs.len() + written.len();
4258        for (output, operand) in list.iter().enumerate() {
4259            let Some(def) = def_of[output] else { continue };
4260            let input = if operand.value.is_some() {
4261                Some(output)
4262            } else {
4263                list.iter().position(|entry| entry.tied == Some(output))
4264            };
4265            let Some(read) = input.and_then(|input| use_of[input]) else { continue };
4266            match defs[def].constraint {
4267                Constraint::Fixed(_) => uses[read].constraint = defs[def].constraint,
4268                _ => {
4269                    let at = u8::try_from(first_use + read).map_err(|_| refused())?;
4270                    defs[def].constraint = Constraint::Reuse(at);
4271                }
4272            }
4273        }
4274
4275        // A line naming an operand in a register, with an instruction on it the reader knows, is
4276        // one the reader refused for a reason of its own, and keeping it as text would hand the
4277        // assembler what the reader already said no to. `addq %1, %k0` is that: a quadword add
4278        // into half a register. What is kept is a line with an instruction nothing here knows.
4279        let registered = |index: usize| def_of[index].is_some() || use_of[index].is_some();
4280        if !a64 && (0..list.len()).any(registered) {
4281            for line in template.split(['\n', ';']) {
4282                if names_one(line, registered)
4283                    && x86_64::known(line, widths, memory)
4284                    && x86_64::read_in(line, widths, memory).is_none()
4285                {
4286                    return Err(refused());
4287                }
4288            }
4289        }
4290
4291        let mut text = String::with_capacity(template.len());
4292        let mut memory: Option<usize> = None;
4293        if basic {
4294            text.push_str(template);
4295        } else {
4296            let mut chars = template.chars().peekable();
4297            // Inside `{att|intel}`, and past the `|` in it, which is the half nobody reads. AArch64
4298            // has one dialect, and a brace there is a list of vector registers.
4299            let mut dialect = false;
4300            let mut skipped = false;
4301            while let Some(c) = chars.next() {
4302                match c {
4303                    '{' if !a64 => {
4304                        dialect = true;
4305                        continue;
4306                    }
4307                    '|' if dialect => {
4308                        skipped = true;
4309                        continue;
4310                    }
4311                    '}' if dialect => {
4312                        dialect = false;
4313                        skipped = false;
4314                        continue;
4315                    }
4316                    _ if skipped => continue,
4317                    '%' => {}
4318                    _ => {
4319                        text.push(c);
4320                        continue;
4321                    }
4322                }
4323                match chars.peek().copied() {
4324                    Some(c @ ('%' | '{' | '|' | '}')) => {
4325                        chars.next();
4326                        text.push(c);
4327                        continue;
4328                    }
4329                    Some('=') => {
4330                        chars.next();
4331                        text.push_str(&inst.index().to_string());
4332                        continue;
4333                    }
4334                    _ => {}
4335                }
4336                let modifier = match chars.peek().copied() {
4337                    Some(c) if c.is_ascii_alphabetic() => {
4338                        chars.next();
4339                        Some(c)
4340                    }
4341                    _ => None,
4342                };
4343                let mut digits = String::new();
4344                while let Some(c) = chars.peek().copied().filter(char::is_ascii_digit) {
4345                    digits.push(c);
4346                    chars.next();
4347                }
4348                let index: usize = digits.parse().map_err(|_| refused())?;
4349                let operand = list.get(index).ok_or_else(refused)?;
4350                if operand.memory && a64 {
4351                    let at = use_of[index].map(|at| first_use + at).ok_or_else(refused)?;
4352                    if modifier.is_some() {
4353                        return Err(refused());
4354                    }
4355                    text.push('[');
4356                    text.push_str(&template_reg(at, 'x'));
4357                    text.push(']');
4358                    continue;
4359                }
4360                if operand.memory {
4361                    if modifier.is_some() || memory.is_some_and(|had| had != index) {
4362                        return Err(refused());
4363                    }
4364                    memory = Some(index);
4365                    text.push_str(x86_64::TEMPLATE_MEM);
4366                    continue;
4367                }
4368                let placed = def_of[index].or(use_of[index].map(|at| first_use + at));
4369                if let Some(at) = placed {
4370                    let value = operand.result.or(operand.value).ok_or_else(refused)?;
4371                    let bits = held_bits(self.source[value].ty);
4372                    // `w` and `x` are the two names every general purpose register has, and one
4373                    // with no modifier is named at the width of its type, as gcc names it. A
4374                    // vector register with no modifier is `v`, which is what gcc writes for one
4375                    // whatever is in it, and the modifiers name the scalar views of it.
4376                    let width = if a64 && files[index] != self.gpr {
4377                        match modifier {
4378                            None => 'v',
4379                            Some(view @ ('b' | 'h' | 's' | 'd' | 'q')) => view,
4380                            Some(_) => return Err(refused()),
4381                        }
4382                    } else if a64 {
4383                        match (modifier, bits) {
4384                            (None, 8 | 16 | 32) | (Some('w'), _) => 'w',
4385                            (None, 64) | (Some('x'), _) => 'x',
4386                            _ => return Err(refused()),
4387                        }
4388                    } else {
4389                        match modifier {
4390                            None => match held_bits(self.source[value].ty) {
4391                                8 => 'b',
4392                                16 => 'w',
4393                                32 => 'k',
4394                                64 => 'q',
4395                                _ => return Err(refused()),
4396                            },
4397                            Some(width @ ('b' | 'w' | 'k' | 'q')) => width,
4398                            // The second byte is a name only four registers have, so it is taken for
4399                            // an operand pinned to one of them and for nothing the allocator chose.
4400                            Some('h') if pinned(operand).and_then(x86_64::gpr_high).is_some() => {
4401                                'h'
4402                            }
4403                            Some(_) => return Err(refused()),
4404                        }
4405                    };
4406                    text.push_str(&template_reg(at, width));
4407                    continue;
4408                }
4409                let value = operand.value.ok_or_else(refused)?;
4410                let bare = match modifier {
4411                    None => false,
4412                    Some('c' | 'P' | 'p') => true,
4413                    Some(_) => return Err(refused()),
4414                };
4415                // A constant is bare on AArch64 whatever the modifier, which is how gcc prints one
4416                // there and a form GNU as takes wherever `#` would go.
4417                if !bare && !a64 {
4418                    text.push('$');
4419                }
4420                if let Some(number) = self.number(value) {
4421                    text.push_str(&number.to_string());
4422                } else if let Some(symbol) = self.named_address(value) {
4423                    text.push_str(&template_name(self.names.resolve(symbol)));
4424                } else {
4425                    return Err(refused());
4426                }
4427            }
4428        }
4429
4430        // An object in this function's frame is named by where it is in the frame, the way gcc
4431        // names it, rather than by a register its address was put in first. The text may write
4432        // registers it does not declare, and tcc's tests do: one that writes `%ecx` behind the
4433        // compiler's back would otherwise take the address with it.
4434        let mut local = None;
4435        let at = match memory.filter(|_| !a64) {
4436            Some(index) => {
4437                let value = list[index].value.ok_or_else(refused)?;
4438                local = self.local_of(value);
4439                let base = match local {
4440                    Some(_) => mir::Reg::physical(self.conv.stack_pointer),
4441                    None => self.reg_of(value)?,
4442                };
4443                Some(mir::Mem::at(mir::Operand::read(base, self.gpr)))
4444            }
4445            None => None,
4446        };
4447        let symbol = self.names.intern(&text);
4448        let opcode = self.named(if a64 { aarch64::TEMPLATE } else { x86_64::TEMPLATE });
4449        let block = self.at.expect("a block is being filled");
4450        let span = self.source.span(inst);
4451        let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4452        for operand in defs.into_iter().chain(written).chain(uses) {
4453            build = build.operand(operand);
4454        }
4455        if let Some(mem) = at {
4456            build = build.mem(mem);
4457        }
4458        let made = build.finish();
4459        if let Some(local) = local {
4460            self.stack.addresses.push((made, local));
4461        }
4462        Ok(())
4463    }
4464
4465    /// The object in this function's frame a value is the address of, for one an `alloca` of a
4466    /// size known here made. See [`Self::reserve`], which is where the `lea` it is found by came
4467    /// from.
4468    fn local_of(&self, value: Value) -> Option<usize> {
4469        let Def::Result { inst, .. } = self.source[value].def else { return None };
4470        if self.source[inst].opcode != Opcode::Alloca
4471            || !self.source[self.source[inst].args].is_empty()
4472        {
4473            return None;
4474        }
4475        let reg = self.regs[value.index()]?;
4476        self.stack.addresses.iter().find_map(|&(made, local)| {
4477            let data = &self.out[made];
4478            let defined = self.out[data.operands].first()?;
4479            (defined.reg == reg).then_some(local)
4480        })
4481    }
4482
4483    /// The name a value is the address of, for one a `global_addr` defined.
4484    fn named_address(&self, value: Value) -> Option<Symbol> {
4485        let Def::Result { inst, .. } = self.source[value].def else { return None };
4486        if self.source[inst].opcode != Opcode::GlobalAddr {
4487            return None;
4488        }
4489        let Extra::Symbol(symbol) = self.source[inst].extra else { return None };
4490        Some(symbol)
4491    }
4492
4493    /// A register holding a zero, for an operand of a template that is read before anything filled
4494    /// it.
4495    ///
4496    /// Two things ask for this and they are the same thing twice. An output the template reads has
4497    /// nothing to be read out of until the instruction that writes it has run, and a loop carries
4498    /// an operand into a block before the instruction that fills it, so both are a use in front of
4499    /// every definition. What the program is owed there is nothing, since the value is undefined
4500    /// either way, and what the allocator is owed is a register something wrote.
4501    fn seeded(&mut self, inst: Inst, operand: AsmOperand<'_>) -> Result<mir::Reg, Unsupported> {
4502        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4503        let value = operand.result.or(operand.value).ok_or_else(refused)?;
4504        let class = self.class_of(self.source[value].ty);
4505        if class != self.gpr {
4506            return Err(refused());
4507        }
4508        let block = self.at.expect("a block is being filled");
4509        let reg = self.out.new_vreg(class);
4510        let put = self.named("mov_ri_64");
4511        self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
4512        Ok(reg)
4513    }
4514
4515    /// A template with labels in it, as the blocks its jumps leave and arrive at.
4516    ///
4517    /// A statement is an instruction of the IR and stands inside one block, so a template that
4518    /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
4519    /// stands in and gives it two arms, and whatever follows the statement goes into whichever
4520    /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
4521    /// what [`Self::saves_place`] already does for the same reason.
4522    ///
4523    /// # What is carried between them
4524    ///
4525    /// The machine IR here is in the form where a register is written once, so an operand written
4526    /// inside a loop and read again at the top of it cannot be one register. What arrives at the
4527    /// top is a parameter of that block, and every jump to it carries whichever register held the
4528    /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
4529    /// made takes one parameter for each operand that is in a register at all, in one order, so an
4530    /// arm's arguments and a block's parameters are the same list read twice.
4531    ///
4532    /// Which register an operand is in at each point is kept in the read half of its place, since
4533    /// that is what the instructions below read it out of. An instruction that writes an operand
4534    /// leaves it in the register it wrote, and a jump below carries that one. The block an
4535    /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
4536    /// about where the operands are changes there.
4537    ///
4538    /// An operand written by the template and filled by nothing is written as a zero first, for
4539    /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
4540    /// instruction that fills it has run, and an argument has to be a register something wrote.
4541    ///
4542    /// # The condition state
4543    ///
4544    /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
4545    /// it are both written here, next to each other in one block, and what the allocator may put
4546    /// between them is a move, which on this machine leaves the condition state alone. The edge
4547    /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
4548    /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
4549    fn woven(
4550        &mut self,
4551        inst: Inst,
4552        steps: &[x86_64::Step],
4553        places: &mut [Place],
4554        list: &[AsmOperand<'_>],
4555        clobbered: &[PhysReg],
4556        writes: &[usize],
4557    ) -> Result<(), Unsupported> {
4558        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4559        let span = self.source.span(inst);
4560
4561        // Which operands are carried, which is every one that is in a register at all. An operand
4562        // the template never puts in one, such as a constant it names only as the distance into an
4563        // address, is in the instruction and has nowhere to be carried from.
4564        let mut carried: Vec<(usize, RegClass)> = Vec::new();
4565        for (index, operand) in list.iter().enumerate() {
4566            if places[index].read.is_none() && places[index].write.is_none() {
4567                continue;
4568            }
4569            let value = operand.result.or(operand.value).ok_or_else(refused)?;
4570            let ty = self.source[value].ty;
4571            if on_x87(ty) {
4572                return Err(refused());
4573            }
4574            carried.push((index, self.class_of(ty)));
4575        }
4576
4577        // What each of them holds where the template starts.
4578        for &(index, _) in &carried {
4579            if places[index].read.is_some() {
4580                continue;
4581            }
4582            if writes[index] == 0 {
4583                places[index].read = places[index].write;
4584                continue;
4585            }
4586            places[index].read = Some(self.seeded(inst, list[index])?);
4587        }
4588
4589        // The blocks, made before the walk because a jump forwards names a label the walk has not
4590        // reached yet.
4591        let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
4592        for step in steps {
4593            let x86_64::Step::Label(name) = step else { continue };
4594            let block = self.out.create_block();
4595            let mut params = Vec::with_capacity(carried.len());
4596            for &(_, class) in &carried {
4597                params.push(self.out.append_param(block, class));
4598            }
4599            labels.push((name.as_str(), block, params));
4600        }
4601
4602        let mut wrote: Vec<usize> = Vec::new();
4603        for step in steps {
4604            match step {
4605                x86_64::Step::Label(name) => {
4606                    let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
4607                    let from = self.at.expect("a block is being filled");
4608                    let args = Self::held(places, &carried).ok_or_else(refused)?;
4609                    *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
4610                    self.at = Some(block);
4611                    for (at, &(index, _)) in carried.iter().enumerate() {
4612                        places[index].read = params.get(at).copied();
4613                    }
4614                }
4615                x86_64::Step::Jump { opcode, to } => {
4616                    let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
4617                    let from = self.at.expect("a block is being filled");
4618                    let args = Self::held(places, &carried).ok_or_else(refused)?;
4619                    let opcode = self.named(opcode);
4620                    self.out.build(from, opcode).at(span).finish();
4621                    let next = self.out.create_block();
4622                    *self.out.succs_mut(from) =
4623                        vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
4624                    self.at = Some(next);
4625                }
4626                x86_64::Step::Away { symbol } => {
4627                    // Only in a function that is written without a prologue, which is the one
4628                    // place the jump means what it says. Anywhere else there is an epilogue behind
4629                    // the statement that puts the registers back and gives the frame up, and a
4630                    // jump over it goes to the next function with this function's frame still
4631                    // taken. The reader already made sure it is the last step of the template, so
4632                    // what is left to ask is about the function around it.
4633                    if !self.source.attrs.set.contains(AttrSet::NAKED) {
4634                        return Err(Unsupported::Assembly { inst, refused: Written::Away });
4635                    }
4636                    let from = self.at.expect("a block is being filled");
4637                    let opcode = self.named(AWAY);
4638                    let symbol = self.names.intern(symbol);
4639                    self.out.build(from, opcode).at(span).symbol(symbol).finish();
4640                    // Nowhere, which is what a jump out of the function leaves behind it and is
4641                    // the same list a `ret` leaves. The block after it is made for the walk above
4642                    // rather than for the program: the statement may be in the middle of a body
4643                    // that goes on being lowered, and what that lowering writes is reached by
4644                    // nothing and thrown away with the block.
4645                    *self.out.succs_mut(from) = Vec::new();
4646                    self.at = Some(self.out.create_block());
4647                }
4648                x86_64::Step::Call { symbol } => {
4649                    self.call_out(inst, symbol, places, list, clobbered, &carried, &mut wrote)?;
4650                }
4651                x86_64::Step::Line(line) => {
4652                    let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4653                    let mut written = Vec::new();
4654                    for (desc, piece) in form.operands().iter().zip(&line.operands) {
4655                        if !desc.role.is_def() {
4656                            continue;
4657                        }
4658                        let index = match *piece {
4659                            x86_64::Piece::Operand { index, .. } => index,
4660                            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
4661                                Some(index) => index,
4662                                None => continue,
4663                            },
4664                            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
4665                                Some(index) => index,
4666                                None => continue,
4667                            },
4668                        };
4669                        written.push(index);
4670                    }
4671                    // A register is written once in this form of the machine IR, so an operand
4672                    // an instruction above already wrote is written into a new one here, and what
4673                    // reads it below reads that one.
4674                    for &index in &written {
4675                        if !wrote.contains(&index) {
4676                            wrote.push(index);
4677                            continue;
4678                        }
4679                        let &(_, class) =
4680                            carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4681                        let place = places.get_mut(index).ok_or_else(refused)?;
4682                        place.write = Some(self.out.new_vreg(class));
4683                    }
4684                    self.instruction(inst, line, places, list, clobbered)?;
4685                    for index in written {
4686                        let place = places.get_mut(index).ok_or_else(refused)?;
4687                        if place.write.is_some() {
4688                            place.read = place.write;
4689                        }
4690                    }
4691                }
4692            }
4693        }
4694
4695        // Where the walk left each output, which is the parameter of the block a label made when
4696        // the template ends in one and the register an instruction wrote when it does not.
4697        for (index, operand) in list.iter().enumerate() {
4698            let Some(result) = operand.result else { continue };
4699            if let Some(reg) = places[index].read {
4700                self.regs[result.index()] = Some(reg);
4701            }
4702        }
4703        Ok(())
4704    }
4705
4706    /// A template's call to a function somewhere else, as the call the convention makes.
4707    ///
4708    /// The opcode is the one a call written in C becomes, so everything that asks whether a
4709    /// function calls anything gets the answer it would for one: the stack pointer is left aligned
4710    /// at the statement and nothing is kept in the red zone. What is not the same is the operands.
4711    /// Nothing is passed by the convention, since the template put the arguments where it wanted
4712    /// them, and what comes back is whatever an output is pinned to, since that is the only thing
4713    /// the template says about it. Every other register the callee may leave anything in is
4714    /// written here, which is what a program that calls from a template never says and always
4715    /// means.
4716    #[allow(clippy::too_many_arguments)]
4717    fn call_out(
4718        &mut self,
4719        inst: Inst,
4720        symbol: &str,
4721        places: &mut [Place],
4722        list: &[AsmOperand<'_>],
4723        clobbered: &[PhysReg],
4724        carried: &[(usize, RegClass)],
4725        wrote: &mut Vec<usize>,
4726    ) -> Result<(), Unsupported> {
4727        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4728        let mut operands = Vec::new();
4729        let mut written = Vec::new();
4730        let lost = self.lost(list);
4731        for &(reg, class, index) in &lost {
4732            let Some(index) = index else {
4733                operands.push(mir::Operand::write(mir::Reg::physical(reg), class));
4734                continue;
4735            };
4736            // Written once in this form of the machine IR, so a second write is a new register,
4737            // the same as for an instruction in [`Self::woven`].
4738            if wrote.contains(&index) {
4739                let &(_, class) =
4740                    carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4741                places.get_mut(index).ok_or_else(refused)?.write = Some(self.out.new_vreg(class));
4742            } else {
4743                wrote.push(index);
4744            }
4745            let place = places.get(index).ok_or_else(refused)?.write.ok_or_else(refused)?;
4746            operands.push(mir::Operand::write(place, class).with(Constraint::Fixed(reg)));
4747            written.push(index);
4748        }
4749        for &reg in clobbered {
4750            if lost.iter().all(|&(gone, class, _)| gone != reg || class != self.gpr) {
4751                operands.push(mir::Operand::write(mir::Reg::physical(reg), self.gpr));
4752            }
4753        }
4754        let block = self.at.expect("a block is being filled");
4755        let span = self.source.span(inst);
4756        let opcode = mir::Opcode::new(self.names.intern(abi::CALL));
4757        let symbol = self.names.intern(symbol);
4758        let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4759        for operand in operands {
4760            build = build.operand(operand);
4761        }
4762        build.finish();
4763        let calls = &mut self.stack.calls;
4764        *calls = Some(calls.unwrap_or(0));
4765        for index in written {
4766            let place = places.get_mut(index).ok_or_else(refused)?;
4767            place.read = place.write;
4768        }
4769        Ok(())
4770    }
4771
4772    /// Every register a call may leave anything in, with its file and the output pinned to it if
4773    /// one is.
4774    ///
4775    /// A register is asked about with its file, since the two files are numbered from nought alike
4776    /// and a question about `v8` alone would find an output pinned to `x8`.
4777    fn lost(&self, list: &[AsmOperand<'_>]) -> Vec<(PhysReg, RegClass, Option<usize>)> {
4778        let conv = self.conv;
4779        let ints = conv.int_order.iter().filter(|&&reg| !conv.preserves_int(reg));
4780        let sses = conv.sse_order.iter().filter(|&&reg| !conv.preserves_sse(reg));
4781        let written = |reg, class| {
4782            list.iter().position(|operand| {
4783                operand.result.is_some() && self.pinned_here(operand) == Some((reg, class))
4784            })
4785        };
4786        ints.map(|&reg| (reg, conv.int_class, written(reg, conv.int_class)))
4787            .chain(sses.map(|&reg| (reg, conv.sse_class, written(reg, conv.sse_class))))
4788            .collect()
4789    }
4790
4791    /// The input an output read before anything wrote it shares its register with, which is the
4792    /// one input that could be in that register, or nothing when there is none or more than one.
4793    ///
4794    /// Could be means nothing ties it elsewhere: it is in a register rather than in memory, no
4795    /// constraint pins it anywhere the output is not, and it is not tied to another output. An
4796    /// output written `&` shares nothing, since the assembly writes it before it reads the inputs.
4797    fn shared(&self, list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
4798        let output = list.get(index)?;
4799        if output.early || output.tied.is_some() {
4800            return None;
4801        }
4802        let class = self.class_of(self.source[output.result?].ty);
4803        let mut fits = list.iter().filter(|operand| {
4804            operand.result.is_none()
4805                && !operand.memory
4806                && operand.tied.is_none()
4807                && operand.value.is_some_and(|value| self.class_of(self.source[value].ty) == class)
4808                && pinned(operand).is_none_or(|reg| pinned(output) == Some(reg))
4809        });
4810        let value = fits.next()?.value;
4811        if fits.next().is_some() {
4812            return None;
4813        }
4814        value
4815    }
4816
4817    /// The block one of the template's labels made, and the parameters it takes.
4818    fn went<'b>(
4819        labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
4820        name: &str,
4821    ) -> Option<(mir::Block, &'b [mir::Reg])> {
4822        labels
4823            .iter()
4824            .find(|(had, ..)| *had == name)
4825            .map(|(_, block, params)| (*block, params.as_slice()))
4826    }
4827
4828    /// The register each carried operand is in, which is what an arm to a label carries.
4829    fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
4830        carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
4831    }
4832
4833    /// The registers a clobber list names, in the order it named them.
4834    ///
4835    /// Nothing is dropped. A name this has no register for is refused, because the list is the
4836    /// program telling the compiler which registers it may not leave anything in, and an entry
4837    /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
4838    /// two entries that are not registers and for why they are skipped rather than refused.
4839    fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
4840        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
4841        let mut named = Vec::new();
4842        for entry in clobbers.split(',') {
4843            let entry = entry.trim().trim_matches('"');
4844            // The sigil is optional in a clobber list and means nothing when it is there, unlike
4845            // in a template, where it is what tells a register from an operand.
4846            let entry = entry.strip_prefix('%').unwrap_or(entry);
4847            if entry.is_empty() || matches!(entry, "memory" | "cc" | "flags") {
4848                continue;
4849            }
4850            let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
4851            if !named.contains(&reg) {
4852                named.push(reg);
4853            }
4854        }
4855        Ok(named)
4856    }
4857
4858    /// [`Self::clobbered`] on AArch64, where a clobber may name a vector register as well as a
4859    /// general purpose one, so each comes back with the file it is in. See [`aarch64::named`].
4860    fn clobbered_a64(inst: Inst, clobbers: &str) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
4861        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
4862        let mut named = Vec::new();
4863        for entry in clobbers.split(',') {
4864            let entry = entry.trim().trim_matches('"');
4865            if entry.is_empty() || matches!(entry, "memory" | "cc") {
4866                continue;
4867            }
4868            let reg = aarch64::named(entry).ok_or_else(refused)?;
4869            if !named.contains(&reg) {
4870                named.push(reg);
4871            }
4872        }
4873        Ok(named)
4874    }
4875
4876    /// Whether the machine being lowered for is AArch64.
4877    fn on_aarch64(&self) -> bool {
4878        std::ptr::eq(self.selector.shapes, &aarch64::MACHINE)
4879    }
4880
4881    /// The register an operand is pinned to on the machine being lowered for.
4882    ///
4883    /// [`pinned`] on x86, where it is always a general purpose register. AArch64 has no constraint
4884    /// letter for one register, so there only a local register variable pins anything, and its name
4885    /// is read against [`aarch64::named`], which may put it in either file. The file comes back with
4886    /// the register because the two are numbered from nought alike, and `x8` is not `v8`.
4887    fn pinned_here(&self, operand: &AsmOperand<'_>) -> Option<(PhysReg, RegClass)> {
4888        if !self.on_aarch64() {
4889            return pinned(operand).map(|reg| (reg, self.gpr));
4890        }
4891        let name = operand.named?;
4892        aarch64::named(name.strip_prefix('%').unwrap_or(name))
4893    }
4894
4895    /// An `asm` statement whose operands are `long double` values on the x87 stack.
4896    ///
4897    /// `t` is the top of the stack and `u` is the register under it, and those two letters, or a
4898    /// number tying an input to an output in one of them, are the only places taken here. That is
4899    /// what glibc's old `<bits/mathinline.h>` writes, `fpatan` with `=t`, `0` and `u` and `st(1)`
4900    /// in the clobber list, and it is gcc-torture `execute/990413-2.c`.
4901    ///
4902    /// The group is the shape every other one in [`Self::x87`] has. The inputs are pushed from the
4903    /// deepest up, so the `t` one is pushed last and ends up on top, then the template runs, then
4904    /// the outputs are popped into their slots from the top down. That leaves the stack as empty
4905    /// as it was found only when the template popped every input it was handed and pushed every
4906    /// output it says it leaves, and gcc's rule for these statements says when that is: an input
4907    /// tied to an output or named in the clobber list is one the template pops. So a statement
4908    /// with an input it leaves behind is refused, as is one with an operand anywhere other than
4909    /// `st(0)` and `st(1)`, since nothing here would know what to do with the stack after it.
4910    fn x87_assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
4911        let data = &self.source[inst];
4912        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4913        let info = self.source[asm];
4914        if !self.source[info.targets].is_empty() {
4915            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
4916        }
4917        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4918        let constraints = self.names.resolve(info.constraints).to_string();
4919        let results: Vec<Value> = data.results().collect();
4920        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
4921            .ok_or_else(refused)?;
4922        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
4923
4924        // Where on the stack each operand is, as a depth from the top.
4925        let letters: Vec<&str> = constraints.split(',').collect();
4926        let mut depths = Vec::with_capacity(list.len());
4927        for (operand, letter) in list.iter().zip(&letters) {
4928            let value = operand.result.or(operand.value).ok_or_else(refused)?;
4929            if operand.memory || !on_x87(self.source[value].ty) {
4930                return Err(refused());
4931            }
4932            let depth = match operand.tied {
4933                Some(output) => *depths.get(output).ok_or_else(refused)?,
4934                None => match letter.trim_start_matches(['=', '+', '&']) {
4935                    "t" => 0,
4936                    "u" => 1,
4937                    _ => return Err(refused()),
4938                },
4939            };
4940            depths.push(depth);
4941        }
4942
4943        // Which depths the clobber list says the template pops.
4944        let clobbers = self.names.resolve(info.clobbers).to_string();
4945        let mut popped = [false; 2];
4946        for entry in clobbers.split(',') {
4947            let entry = entry.trim().trim_matches('"');
4948            let entry = entry.strip_prefix('%').unwrap_or(entry);
4949            match entry {
4950                "" | "memory" | "cc" | "flags" => {}
4951                "st" | "st(0)" => popped[0] = true,
4952                "st(1)" => popped[1] = true,
4953                _ => return Err(Unsupported::Assembly { inst, refused: Written::Clobber }),
4954            }
4955        }
4956
4957        // The inputs, one per depth and from the top down with no gap, and each one popped.
4958        let mut inputs: Vec<Option<Value>> = vec![None; 2];
4959        let mut outputs: Vec<Option<Value>> = vec![None; 2];
4960        for (index, operand) in list.iter().enumerate() {
4961            let depth = depths[index];
4962            if let Some(result) = operand.result {
4963                if outputs[depth].replace(result).is_some() {
4964                    return Err(refused());
4965                }
4966            }
4967            let Some(value) = operand.value else { continue };
4968            // An output written `+` is an input tied to itself.
4969            let consumed = operand.result.is_some() || operand.tied.is_some() || popped[depth];
4970            if !consumed {
4971                return Err(refused());
4972            }
4973            if inputs[depth].replace(value).is_some() {
4974                return Err(refused());
4975            }
4976        }
4977        let gapless =
4978            |held: &[Option<Value>]| held.iter().skip_while(|it| it.is_some()).all(Option::is_none);
4979        if !gapless(&inputs) || !gapless(&outputs) {
4980            return Err(refused());
4981        }
4982
4983        // The text, with an operand spelled as the register it is in.
4984        let template = self.names.resolve(info.template).to_string();
4985        let mut text = String::with_capacity(template.len());
4986        let mut chars = template.chars().peekable();
4987        while let Some(c) = chars.next() {
4988            if c != '%' {
4989                text.push(c);
4990                continue;
4991            }
4992            match chars.peek().copied() {
4993                Some('%') => {
4994                    chars.next();
4995                    text.push('%');
4996                }
4997                Some('=') => {
4998                    chars.next();
4999                    text.push_str(&inst.index().to_string());
5000                }
5001                Some(digit) if digit.is_ascii_digit() => {
5002                    chars.next();
5003                    if chars.peek().is_some_and(char::is_ascii_digit) {
5004                        return Err(refused());
5005                    }
5006                    let index = digit.to_digit(10).map_or(usize::MAX, |it| it as usize);
5007                    match depths.get(index).ok_or_else(refused)? {
5008                        0 => text.push_str("%st"),
5009                        depth => text.push_str(&format!("%st({depth})")),
5010                    }
5011                }
5012                _ => return Err(refused()),
5013            }
5014        }
5015
5016        let span = self.source.span(inst);
5017        for value in inputs.iter().rev().flatten() {
5018            let from = self.x87_slot(*value);
5019            let from = self.through(from);
5020            self.x87_at("fld_t", span, from);
5021        }
5022        let symbol = self.names.intern(&text);
5023        let opcode = self.named(x86_64::TEMPLATE);
5024        let block = self.at.expect("a block is being filled");
5025        self.out.build(block, opcode).at(span).symbol(symbol).finish();
5026        for value in outputs.iter().flatten() {
5027            let into = self.x87_slot(*value);
5028            let into = self.through(into);
5029            self.x87_at("fstp_t", span, into);
5030        }
5031        Ok(())
5032    }
5033
5034    /// An `asm` statement on AArch64, which is kept as text whatever is in it.
5035    ///
5036    /// Nothing reads AArch64 assembly back into instructions yet, so every template goes the way
5037    /// one the x86 reader could not take apart goes, which is [`Self::kept`]: the text is carried
5038    /// to the listing with a hole for each operand, and the operands are the instruction's own. A
5039    /// constraint with a letter whose meaning differs between the two machines is refused first.
5040    /// See [`shared_letters`].
5041    fn spelled(&mut self, inst: Inst) -> Result<(), Unsupported> {
5042        let data = &self.source[inst];
5043        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
5044        let info = self.source[asm];
5045        if self.jumps_from_text(inst) {
5046            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
5047        }
5048        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5049        let constraints = self.names.resolve(info.constraints).to_string();
5050        if !constraints.split(',').all(shared_letters) {
5051            return Err(refused());
5052        }
5053        // `Q` is memory addressed by one register and nothing else, which is how every operand in
5054        // memory is spelled here already, so it is read as `m`. See [`shared_letters`].
5055        let constraints = letters_outside(&constraints, |c| if c == 'Q' { 'm' } else { c });
5056        let results: Vec<Value> = data.results().collect();
5057        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
5058            .ok_or_else(refused)?;
5059        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
5060        let widths = vec![None; list.len()];
5061        let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
5062        let template = self.names.resolve(info.template).to_string();
5063        self.kept(inst, &template, &list, &widths, &memory)
5064    }
5065
5066    /// One instruction of a template, as the machine instruction it was read back into.
5067    fn instruction(
5068        &mut self,
5069        inst: Inst,
5070        line: &x86_64::Line,
5071        places: &[Place],
5072        list: &[AsmOperand<'_>],
5073        clobbered: &[PhysReg],
5074    ) -> Result<(), Unsupported> {
5075        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5076        let form = x86_64::form(line.opcode).ok_or_else(refused)?;
5077        // What the instruction reaches and what is in each of them. The description answers the
5078        // first for every opcode but one, and the pieces the template was read into answer the
5079        // second. Bytes a program wrote out itself are the one, since nothing in a number is a
5080        // register anybody could read, so the constraint letters answer both. See
5081        // [`Self::lettered`].
5082        let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
5083        let (described, pieces) = match &lettered {
5084            Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
5085            None => (form.operands(), line.operands.as_slice()),
5086        };
5087        let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
5088        for (desc, piece) in described.iter().zip(pieces) {
5089            built.push(self.placed(inst, *desc, *piece, places, list)?);
5090        }
5091        // The clobbers go in among the definitions rather than behind the reads, because an operand
5092        // vector in the machine IR is every definition and then every use and what counts them
5093        // reads that order rather than each operand's role.
5094        let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
5095        let mut added = 0usize;
5096        for &reg in clobbered {
5097            if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
5098                continue;
5099            }
5100            built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
5101            added += 1;
5102        }
5103        // A constraint tying one operand to another names it by its place in this vector, and the
5104        // clobbers were put in the middle of the vector, so everything behind them moved. The
5105        // description is written against an instruction with no clobbers in it and cannot know
5106        // that, which makes this the one place the two numberings have to be reconciled.
5107        for operand in &mut built {
5108            if let Constraint::Reuse(at) = operand.constraint {
5109                if usize::from(at) >= defs {
5110                    let moved = usize::from(at) + added;
5111                    operand.constraint =
5112                        Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
5113                }
5114            }
5115        }
5116        let at = match line.at {
5117            Some(at) => Some(self.addressed(inst, at, places, list)?),
5118            None => None,
5119        };
5120
5121        let block = self.at.expect("a block is being filled");
5122        let span = self.source.span(inst);
5123        let opcode = self.named(line.opcode);
5124        let mut build = self.out.build(block, opcode).at(span);
5125        for operand in built {
5126            build = build.operand(operand);
5127        }
5128        if let Some(value) = line.imm {
5129            build = build.imm(value);
5130        }
5131        if let Some(mem) = at {
5132            build = build.mem(mem);
5133        }
5134        build.finish();
5135        Ok(())
5136    }
5137
5138    /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
5139    /// description of an opcode.
5140    ///
5141    /// Every other instruction of a template has a description saying which registers it reaches
5142    /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
5143    /// wrote out itself have no such description and could not have one: what the instruction is, is
5144    /// a number, and nothing in a number is a register anything could read. So the letters are the
5145    /// whole of what is known, and they are enough, because a program writing an instruction this
5146    /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
5147    ///
5148    /// Each register named by a letter gets one entry for the write and one for the read, the same
5149    /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
5150    /// written here and one no input names is not read. The writes come first because that is the
5151    /// order an operand vector in the machine IR is counted in. A register named by nothing is left
5152    /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
5153    /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
5154    /// touch is known only from what the program said.
5155    fn lettered(&self, list: &[AsmOperand<'_>]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
5156        let mut named: Vec<PhysReg> = Vec::new();
5157        for operand in list {
5158            if let Some(reg) = pinned(operand) {
5159                if !named.contains(&reg) {
5160                    named.push(reg);
5161                }
5162            }
5163        }
5164        let mut described = Vec::with_capacity(named.len() * 2);
5165        let mut pieces = Vec::with_capacity(named.len() * 2);
5166        for role in [Role::Def, Role::Use] {
5167            for &reg in &named {
5168                if bound(list, reg, role).is_none() {
5169                    continue;
5170                }
5171                let desc = if role.is_def() {
5172                    OperandDesc::write(self.gpr)
5173                } else {
5174                    OperandDesc::read(self.gpr)
5175                };
5176                described.push(desc.with(Constraint::Fixed(reg)));
5177                pieces.push(x86_64::Piece::Implicit { reg });
5178            }
5179        }
5180        (described, pieces)
5181    }
5182
5183    /// One operand of one instruction of a template, in the register the statement put it in.
5184    fn placed(
5185        &mut self,
5186        inst: Inst,
5187        desc: OperandDesc,
5188        piece: x86_64::Piece,
5189        places: &[Place],
5190        list: &[AsmOperand<'_>],
5191    ) -> Result<mir::Operand, Unsupported> {
5192        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5193        // A register the instruction reaches without its text naming it belongs to whichever of the
5194        // statement's operands a constraint letter put there, and to nobody when no letter did.
5195        // There is no width to check in that case: the operand is the register the letter named and
5196        // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
5197        let (index, spelled) = match piece {
5198            x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
5199            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
5200                Some(index) => (index, None),
5201                None => return self.spare(inst, desc),
5202            },
5203            // A register the template named, which belongs to one of the statement's operands when
5204            // a constraint letter put that operand there and to nobody otherwise. Asked in that
5205            // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
5206            // the program saying one thing twice, and answering it twice would hand the allocator
5207            // one register holding two values.
5208            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
5209                Some(index) => (index, None),
5210                None => return self.itself(inst, desc, reg),
5211            },
5212        };
5213        let operand = list.get(index).copied().ok_or_else(refused)?;
5214        // The two halves of an operand written `+`, which arrives in one register and leaves in
5215        // another with the allocator told to make them the same one. Everything else has one of
5216        // the two and asking for the other is the refusal below.
5217        let place = places.get(index).copied().ok_or_else(refused)?;
5218        let reg = match desc.role {
5219            Role::Use => place.read,
5220            Role::Def | Role::EarlyDef => place.write,
5221        }
5222        .ok_or_else(refused)?;
5223
5224        // Read where the opcode reads and written where it writes, which is what the first half of
5225        // this asks. An output has a result and an input has a value, an output written `+` has
5226        // both because it is read before it is written, and an output a matching constraint names
5227        // is read as the input that named it. See [`read_as`].
5228        // An output with neither is read as well, and what it holds there is undefined, which
5229        // [`Self::assembly`] says why and puts a zero in a register for.
5230        let placeable = match desc.role {
5231            Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
5232            Role::Def | Role::EarlyDef => operand.result.is_some(),
5233        };
5234        let ty = match (operand.result, operand.value) {
5235            (Some(result), _) => self.source[result].ty,
5236            (None, Some(value)) => self.source[value].ty,
5237            (None, None) => return Err(refused()),
5238        };
5239        let bits = held_bits(ty);
5240        if !placeable || self.class_of(ty) != desc.class {
5241            return Err(refused());
5242        }
5243        if let Some((width, stated)) = spelled {
5244            // An operand the template wrote a width on may be written by an instruction that fills
5245            // more of the register than the object in it does, and the object is then the low part
5246            // of what was written. That is what gmp asks for when it counts the low zero bits of a
5247            // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
5248            // the whole register and the `unsigned` is the bottom of it, which is every bit of an
5249            // answer that cannot exceed sixty four anyway.
5250            //
5251            // An operand read at a width the template wrote is the other way round: the object is
5252            // in the register and the instruction looks at the bottom of it. tcc tests the low bits
5253            // of a `size_t` count with `testb $2,%b4`, and every bit that test reads is one the
5254            // object put there.
5255            //
5256            // A write of less of a register than the object fills is right in one case, which is
5257            // an instruction that reads the register it writes and an operand that arrives with
5258            // the object in it. The top of the register is then the top of the object, and the
5259            // instruction leaves it alone. tcc swaps the bytes of an `unsigned` with `xchgb
5260            // %b0,%h0` and a rotate between two of them, and the swap only ever touches the low
5261            // half.
5262            //
5263            // The two that stay refused are a read of more of a register than its type fills,
5264            // which hands an instruction bits nothing ever put there, and a write of less of one
5265            // that nothing carried the object into, which leaves the top of the object holding
5266            // whatever the register held before. An operand the template left plain is refused
5267            // either way, because what gets spelled for that one is the register at the width of
5268            // its type and no other instruction is the one written down.
5269            let carried = matches!(desc.constraint, Constraint::Reuse(_) | Constraint::Fixed(_))
5270                && read_as(list, index).is_some();
5271            // The other case is the one the machine settles by itself: a write of the low four
5272            // bytes of a register clears the four above them, so a sixty four bit object written
5273            // that way holds the thirty two bit answer and nothing else. tcc loads a word through
5274            // `movl 4(%0),%k0` into a `long` and means exactly that.
5275            let cleared = desc.class == self.gpr && width == x86_64::Width::Long && bits == 64;
5276            let widened = stated && desc.role.is_def() && width.bits() > bits;
5277            let narrowed =
5278                stated && width.bits() < bits && (!desc.role.is_def() || carried || cleared);
5279            if bits != width.bits() && !widened && !narrowed {
5280                return Err(refused());
5281            }
5282        }
5283        // An operand the program pinned is in that register and nowhere else, whatever the opcode
5284        // would have allowed it. That is the whole of what a local register variable asks for, and
5285        // it is the same shape a division already has: the allocator is told the register, puts a
5286        // move in front or behind where it has to, and leaves it out where it does not.
5287        let constraint = match pinned(&operand) {
5288            Some(reg) => Constraint::Fixed(reg),
5289            None => desc.constraint,
5290        };
5291        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint })
5292    }
5293
5294    /// A register the template named in its own text.
5295    ///
5296    /// Not one of the statement's operands and not something the allocator handed out. The program
5297    /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
5298    /// something the constraint letters cannot say is made of: micropython saves the callee-saved
5299    /// registers into a buffer by name because the whole point of the buffer is that those exact
5300    /// registers are in it, and there is no constraint letter for `%rsp`.
5301    ///
5302    /// So it is placed as itself, fixed to the register the template named. What that buys is the
5303    /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
5304    /// write of one is a definition it knows about and will not leave anything of the program's
5305    /// across, and a read of one is a use it will not have put something else in first. gcc copies
5306    /// the text out and a register two things believe they own is a wrong program nothing reports.
5307    /// Here the allocator is told, and a program that also named the register in its clobber list
5308    /// says the same thing twice rather than something new.
5309    fn itself(
5310        &mut self,
5311        inst: Inst,
5312        desc: OperandDesc,
5313        reg: PhysReg,
5314    ) -> Result<mir::Operand, Unsupported> {
5315        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5316        if desc.class != self.gpr {
5317            return Err(refused);
5318        }
5319        Ok(mir::Operand {
5320            reg: mir::Reg::physical(reg),
5321            class: self.gpr,
5322            role: desc.role,
5323            constraint: Constraint::Fixed(reg),
5324        })
5325    }
5326
5327    /// A register an instruction of a template uses and the statement put nothing in.
5328    ///
5329    /// A write of one is the register being destroyed, which is what a clobber list is usually
5330    /// written to say and what an instruction with more answers than the program asked for does
5331    /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
5332    /// register of its own is the whole of what that needs, since a value nothing reads is one the
5333    /// allocator may put anywhere and is told about so that nothing else is put there.
5334    ///
5335    /// A read of one is a register the instruction looks at and the program never filled, which
5336    /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
5337    /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
5338    /// zero is the one answer that reads the same on every run.
5339    fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
5340        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5341        if desc.class != self.gpr {
5342            return Err(refused);
5343        }
5344        let reg = self.out.new_vreg(desc.class);
5345        if !desc.role.is_def() {
5346            let block = self.at.expect("a block is being filled");
5347            let span = self.source.span(inst);
5348            let put = self.named("mov_ri_64");
5349            self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
5350        }
5351        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
5352    }
5353
5354    /// The address one instruction of a template reads or writes.
5355    fn addressed(
5356        &mut self,
5357        inst: Inst,
5358        at: x86_64::At,
5359        places: &[Place],
5360        list: &[AsmOperand<'_>],
5361    ) -> Result<mir::Mem, Unsupported> {
5362        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5363        let base = match at.base {
5364            None => None,
5365            Some(x86_64::Piece::Operand { index, .. }) => {
5366                // The register an address is counted from is read and never written, whatever the
5367                // instruction does to what it finds there.
5368                let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5369                Some(mir::Operand::read(reg, self.gpr))
5370            }
5371            // A register the template named, counted from as itself. See [`Self::itself`], and note
5372            // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
5373            // names one register as the thing being stored and another as where to store it. An
5374            // operand a constraint letter put in that register is that operand, for the reason
5375            // [`Self::placed`] gives.
5376            Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
5377                Some(index) => {
5378                    let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5379                    Some(mir::Operand::read(reg, self.gpr))
5380                }
5381                None => Some(
5382                    mir::Operand::read(mir::Reg::physical(reg), self.gpr)
5383                        .with(Constraint::Fixed(reg)),
5384                ),
5385            },
5386            // An address counted from a register the instruction reaches without being told is
5387            // not something this machine has: every addressing mode is written out in the text it
5388            // is part of, so a base that got here another way is a base nothing wrote down.
5389            Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
5390        };
5391        // A distance the template wrote, or the one in an operand the template pointed at, which is
5392        // the same distance said by something that knows how big a thing is. It has to be a number
5393        // the compiler can read at translation time, since it goes in the instruction rather than
5394        // in a register, and an operand holding anything else is refused rather than put somewhere.
5395        let disp = match at.disp {
5396            x86_64::Disp::Number(disp) => disp,
5397            x86_64::Disp::Operand(index) => {
5398                let value =
5399                    list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
5400                let number = self.number(value).ok_or_else(refused)?;
5401                i32::try_from(number).map_err(|_| refused())?
5402            }
5403        };
5404        Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
5405    }
5406
5407    /// The number in that value, for one an `iconst` defined, read at the width of its own type.
5408    ///
5409    /// Signed, because the two things a template asks this for are a distance into an address and
5410    /// the number on an instruction, and both of those are signed wherever they land. A constant
5411    /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
5412    /// which is the same number and is the reading that fits in the thirty two bits an addressing
5413    /// mode has room for.
5414    fn number(&self, value: Value) -> Option<i128> {
5415        let Def::Result { inst, .. } = self.source[value].def else { return None };
5416        if self.source[inst].opcode != Opcode::IConst {
5417            return None;
5418        }
5419        let Extra::Imm(imm) = self.source[inst].extra else { return None };
5420        let bits = self.source[imm].bits();
5421        let width = self.source[value].ty.bits();
5422        if width == 0 || width > 128 {
5423            return None;
5424        }
5425        let spare = 128 - width;
5426        Some(((bits << spare) as i128) >> spare)
5427    }
5428
5429    /// A register holding a value the program has no claim on, written as a zero.
5430    ///
5431    /// Every other way of saying it costs the same instruction or needs a word the machine IR does
5432    /// not have, and a zero is the one that reads the same on every run.
5433    fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
5434        let ty = self.source[result].ty;
5435        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5436        let bits = held_bits(ty);
5437        if self.class_of(ty) != self.gpr || !matches!(bits, 8 | 16 | 32 | 64) {
5438            return Err(refused);
5439        }
5440        let block = self.at.expect("a block is being filled");
5441        let span = self.source.span(inst);
5442        let reg = self.new_reg(result);
5443        let put = self.named(&format!("mov_ri_{bits}"));
5444        self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
5445        Ok(())
5446    }
5447
5448    /// Whether a type is the width an address is, which is what makes a cast to or from one free.
5449    fn is_address_width(&self, ty: Type) -> bool {
5450        ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
5451    }
5452
5453    /// Where a block goes, which in machine IR is on the block rather than on its terminator.
5454    ///
5455    /// That is why no rule ever names a block: a branch is selected for what it reads and the
5456    /// edges are copied across here, arguments and all. The arguments are read last, after every
5457    /// instruction of the block is written, because an argument that is a constant is
5458    /// materialized where it is first wanted and the end of the block is where an edge wants it.
5459    ///
5460    /// Which is not quite the end. A block that leaves two ways has the branch as its last
5461    /// instruction, and a block that leaves through a register has the indirect jump as its last,
5462    /// and anything appended after either is something it has already jumped past, so a constant
5463    /// materialized here would be a register the block below reads and nothing ever writes. The
5464    /// one that was there is put back on the end when that happened, which is the only reordering
5465    /// anything in this crate does and is why it is remembered before a single argument is read.
5466    fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5467        let Some(term) = self.source.terminator(block) else { return Ok(()) };
5468        // An `asm goto` whose template has nothing in it can only fall through, since there is no
5469        // instruction in it to jump with, so the only edge the machine block gets is the first
5470        // one. The labels it names are still arms in the IR, which is what kept the passes above
5471        // from assuming anything about the way into them, and here they are blocks nothing jumps
5472        // to, the same as a label no `goto` names. One that does have instructions was refused by
5473        // [`Self::jumps_from_text`] before this.
5474        if self.source[term].opcode == Opcode::InlineAsm {
5475            let Some(call) = self.source.successors(term).next() else { return Ok(()) };
5476            let args: Vec<Value> = self.source[call.args].to_vec();
5477            let regs =
5478                args.into_iter().map(|value| self.reg_of(value)).collect::<Result<_, _>>()?;
5479            *self.out.succs_mut(out) = vec![mir::BlockCall::with(self.out_block(call.block), regs)];
5480            return Ok(());
5481        }
5482        let leaves =
5483            matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr | Opcode::Switch);
5484        let branch = if leaves { self.out.terminator(out) } else { None };
5485
5486        let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5487        let mut succs = Vec::with_capacity(calls.len());
5488        for call in calls {
5489            let args: Vec<Value> = self.source[call.args].to_vec();
5490            let mut regs = Vec::with_capacity(args.len());
5491            for value in args {
5492                // The address of where the value is rather than the value, for the one type a
5493                // register holds none of. The block on the other side copies the bytes out of it
5494                // into a slot of its own, which is what makes a second edge into the same block
5495                // safe.
5496                let reg = if on_x87(self.source[value].ty) {
5497                    self.x87_slot(value)
5498                } else {
5499                    self.reg_of(value)?
5500                };
5501                regs.push(reg);
5502            }
5503            succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
5504        }
5505        if let Some(branch) = branch {
5506            if self.out.terminator(out) != Some(branch) {
5507                self.out.remove_inst(branch);
5508                self.out.append_inst(out, branch);
5509            }
5510        }
5511        *self.out.succs_mut(out) = succs;
5512        Ok(())
5513    }
5514
5515    /// Whether an `asm goto` has instructions in its template, which is what it would jump with.
5516    ///
5517    /// One with an empty template is what a program writes to tell the optimizer that control may
5518    /// arrive at a label without saying how, and the torture suite has several of them. It never
5519    /// jumps, so it is written as the statement it would be without its labels and a fall through
5520    /// into its first arm. See [`Self::edges`]. One with anything in it needs the labels it names
5521    /// written into the text and an edge for each of them the allocator knows about, and that is
5522    /// still refused.
5523    fn jumps_from_text(&self, inst: Inst) -> bool {
5524        let Extra::Asm(asm) = self.source[inst].extra else { return false };
5525        let info = self.source[asm];
5526        !self.source[info.targets].is_empty()
5527            && !self.names.resolve(info.template).trim().is_empty()
5528    }
5529
5530    /// The machine IR block an IR block became.
5531    fn out_block(&self, block: Block) -> mir::Block {
5532        self.blocks[block.index()].expect("every block was created before any was filled")
5533    }
5534
5535    /// The parameters of the entry block, which are the function's arguments.
5536    ///
5537    /// They are not block parameters in the machine IR and they cannot be. A block parameter is
5538    /// given its value by a move on the edge into the block, and there is no edge into an entry
5539    /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
5540    /// says it.
5541    ///
5542    /// The ones past the last register arrived in the caller's memory and are read out of it, and
5543    /// the loads that read them come back here so that the frame can finish them the way it
5544    /// finishes an `alloca`.
5545    fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5546        let params = self.source[block].params.clone();
5547        // The type of each is the block's answer and what the ABI asks of it is the signature's,
5548        // and the two lists are the same list: a parameter the classification turned into a
5549        // pointer is a pointer in the block too. A block with more parameters than the signature
5550        // names is not one the front end writes, and each of those is taken as a plain value.
5551        let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
5552        let types: Vec<Param> = params
5553            .iter()
5554            .enumerate()
5555            .map(|(index, &value)| {
5556                let abi = asked.get(index).copied().unwrap_or_default();
5557                Param { ty: self.source[value].ty, abi }
5558            })
5559            .collect();
5560        // A save area for a function that takes arguments its signature does not name, which is a
5561        // block of this function's frame on one convention and the shadow space the caller already
5562        // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
5563        // [`Self::save_area`] is where the difference is spent.
5564        //
5565        // Apple's AArch64 is neither. Every argument a signature does not name is in the caller's
5566        // memory, so there is nothing to save and the list starts at the first word past the named
5567        // ones.
5568        //
5569        // A function holding `__builtin_apply_args` asks for the same area whether it is variadic
5570        // or not, because what it saves is every argument register, and the area is where the
5571        // walk that binds them says where each one goes.
5572        let variadic = self.source.signature().variadic;
5573        let in_memory = self.conv.abi.variadic == Variadic::AlwaysMemory;
5574        let applies = self.saves_arguments();
5575        let area = (variadic && !in_memory || applies).then(|| varargs::Area::of(self.conv));
5576        let arrived =
5577            abi::entry(&mut self.out, out, &types, self.conv, self.selector.abi, self.names, area)
5578                .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
5579        for (&param, reg) in params.iter().zip(&arrived.regs) {
5580            self.regs[param.index()] = Some(*reg);
5581        }
5582        if applies {
5583            self.save_arguments(out, &arrived);
5584        }
5585        if let (true, Some(area)) = (variadic && !in_memory, area) {
5586            self.save_area(out, &arrived, area);
5587        } else if variadic {
5588            let incoming = arrived.beyond.next_multiple_of(self.conv.word);
5589            self.varargs = Some(Varargs::Pointer { incoming });
5590        }
5591        self.stack.arguments.extend(arrived.stack);
5592        Ok(())
5593    }
5594
5595    /// The prologue of a variadic function, which is every argument register it was handed written
5596    /// into the frame.
5597    ///
5598    /// Every one the signature did not name, that is. Which of those hold anything is a thing only
5599    /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
5600    /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
5601    /// ever reads their slots.
5602    ///
5603    /// What that costs is up to fourteen stores in the prologue of a function that may read none of
5604    /// them, and the convention's answer to that is the count of vector registers in `%al`, which
5605    /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
5606    /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
5607    /// has no blocks to branch between. So they are all written every time, which is correct and is
5608    /// what `-O0` costs. Issue #323 is the branch.
5609    ///
5610    /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
5611    /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
5612    /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
5613    ///
5614    /// The address is computed once into a register rather than written as a displacement off the
5615    /// stack pointer, because a displacement into a frame is not known until after allocation and
5616    /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
5617    /// gets and [`crate::finish`] fills it in the same way.
5618    ///
5619    /// A convention that homes its register arguments has none of that. Its area is the shadow
5620    /// space the caller reserved above the return address, so there is no object to make and no
5621    /// address to work out: each store reaches into the caller's argument area the way the load of
5622    /// a parameter the registers ran out before does, which is the same waiting list and the same
5623    /// fixup. There are at most four of them and none is a vector register, since a float the
5624    /// signature does not name arrived in a general purpose register too and that is the copy the
5625    /// walk reads.
5626    fn save_area(&mut self, out: mir::Block, arrived: &abi::Arrived, area: varargs::Area) {
5627        if self.conv.shared_positions {
5628            self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
5629            let store = self.named("mov_mr_64");
5630            for &(reg, class, at) in &arrived.spare {
5631                let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
5632                let made =
5633                    self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
5634                self.stack.arguments.push((made, at));
5635            }
5636            return;
5637        }
5638
5639        let save = self.stack.locals.len();
5640        self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
5641        let took = |count: usize, float: bool| {
5642            let count = u32::try_from(count).unwrap_or(0).min(area.holds(float));
5643            area.starts_at(float) + count * area.stride(float)
5644        };
5645        let integers = took(arrived.took.0, false);
5646        let floats = took(arrived.took.1, true);
5647        self.varargs = Some(if self.conv.list == VaList::Aapcs {
5648            // Minus what is left of each half, since the two offsets count up to its top.
5649            let left = |at: u32, float: bool| {
5650                i32::try_from(at).unwrap_or(0) - i32::try_from(area.ends_at(float)).unwrap_or(0)
5651            };
5652            Varargs::Aapcs {
5653                save,
5654                incoming: arrived.beyond,
5655                integers_end: area.ends_at(false),
5656                floats_end: area.ends_at(true),
5657                integers: left(integers, false),
5658                floats: left(floats, true),
5659            }
5660        } else {
5661            Varargs::Fields { save, incoming: arrived.beyond, integers, floats }
5662        });
5663
5664        // A vector register is saved all sixteen bytes wide, as a quad is, whatever it held.
5665        let base = self.frame_address(out, save);
5666        for &(reg, class, at) in &arrived.spare {
5667            let ty =
5668                if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
5669            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5670            let store = mir::Opcode::new(self.names.intern(head));
5671            let up = i32::try_from(at).expect("a register save area under two gigabytes");
5672            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
5673            self.out.build(out, store).uses(reg, class).mem(mem).finish();
5674        }
5675    }
5676
5677    /// Whether the function holds a `__builtin_apply_args`, on a convention this can save the
5678    /// arguments of.
5679    ///
5680    /// Only the one that keeps the two register files apart and saves them the way a SysV list
5681    /// does, since the block is that layout with one word in front of it. On any other the call is
5682    /// refused where it stands, which is [`Self::apply_args`] finding nothing saved.
5683    fn saves_arguments(&self) -> bool {
5684        if self.conv.list != VaList::SysV || self.conv.shared_positions {
5685            return false;
5686        }
5687        let source = self.source;
5688        source
5689            .blocks()
5690            .any(|block| source.insts(block).any(|inst| source[inst].opcode == Opcode::ApplyArgs))
5691    }
5692
5693    /// The prologue of a function holding `__builtin_apply_args`, which is every argument register
5694    /// it was handed and where the arguments in memory start, written into a block of its frame.
5695    ///
5696    /// The block is the one gcc lays out on this convention, so that a program reading it the way
5697    /// gcc's manual says reads the same bytes:
5698    ///
5699    /// ```text
5700    ///   0        where the arguments that came in memory are
5701    ///   8        nothing, so that what follows is sixteen byte aligned
5702    ///   16..64   the six general purpose argument registers, a word each
5703    ///   64..192  the eight vector argument registers, sixteen bytes each
5704    /// ```
5705    ///
5706    /// Which is the register save area of a variadic function with a word and a pad in front, so
5707    /// the offsets are that area's plus sixteen. What is different is that every register is
5708    /// written and not only the ones no parameter took: the one a parameter arrived in is written
5709    /// from the register the parameter was bound to, which holds it untouched because nothing has
5710    /// run yet, and the rest from the pseudos the walk made for them.
5711    fn save_arguments(&mut self, out: mir::Block, arrived: &abi::Arrived) {
5712        let applied = self.stack.locals.len();
5713        self.stack.locals.push(Local { size: APPLY_ARGS, align: varargs::VECTOR_SLOT });
5714        self.applied = Some(applied);
5715        let base = self.frame_address(out, applied);
5716        let overflow = self.overflow(out, 0, Span::DUMMY);
5717        let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
5718        let store = mir::Opcode::new(self.names.intern(head));
5719        let mem = mir::Mem::at(mir::Operand::read(base, self.gpr));
5720        self.out.build(out, store).uses(overflow, self.gpr).mem(mem).finish();
5721
5722        let named = arrived.named.iter().map(|&(index, at)| {
5723            let reg = arrived.regs[index];
5724            let class = self.out.class_of(reg).unwrap_or(self.gpr);
5725            (reg, class, at)
5726        });
5727        let every: Vec<_> = named.chain(arrived.spare.iter().copied()).collect();
5728        for (reg, class, at) in every {
5729            let ty =
5730                if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
5731            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5732            let store = mir::Opcode::new(self.names.intern(head));
5733            let up = i32::try_from(at + APPLY_REGS).expect("a block of under two gigabytes");
5734            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
5735            self.out.build(out, store).uses(reg, class).mem(mem).finish();
5736        }
5737    }
5738
5739    /// One `__builtin_apply_args`, which is the address of the block the prologue wrote.
5740    fn apply_args(&mut self, inst: Inst) -> Result<(), Unsupported> {
5741        let Some(applied) = self.applied else { return Err(self.unsupported(inst)) };
5742        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5743        let block = self.at.expect("a block is being filled");
5744        let reg = self.frame_address(block, applied);
5745        self.regs[result.index()] = Some(reg);
5746        Ok(())
5747    }
5748
5749    /// One `__builtin_apply`, which is a call whose arguments are every register in a block
5750    /// `__builtin_apply_args` answered and some bytes of the memory it says the arguments in
5751    /// memory were in.
5752    ///
5753    /// Built as a call of fourteen arguments, six words and eight vectors, which puts each in the
5754    /// register it came out of, and one object of the size the program gave, which is copied into
5755    /// the bottom of the outgoing area the way a structure passed by value is. The call is made as
5756    /// to a variadic function, so the count of vector registers is eight and a variadic callee
5757    /// saves all of them.
5758    ///
5759    /// What comes back is every register a value can come back in, which is two of each file, and
5760    /// they are written into a block of this function's frame whose address is the answer: the two
5761    /// words at 0 and 8 and the two vectors at 16 and 32. An eighty bit value comes back on the x87
5762    /// stack and is not in it, which is the one thing gcc's block holds that this one does not.
5763    fn apply(&mut self, inst: Inst) -> Result<(), Unsupported> {
5764        if self.conv.list != VaList::SysV || self.conv.shared_positions {
5765            return Err(self.unsupported(inst));
5766        }
5767        let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
5768        let [function, saved, size] = values[..] else { return Err(self.unsupported(inst)) };
5769        let size = self.number(size).ok_or_else(|| self.unsupported(inst))?;
5770        let size = u32::try_from(size).map_err(|_| self.unsupported(inst))?;
5771        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5772        let function = self.reg_of(function)?;
5773        let saved = self.reg_of(saved)?;
5774        let block = self.at.expect("a block is being filled");
5775        let span = self.source.span(inst);
5776
5777        let word = Type::int(64);
5778        let vector = Type::float(rucc_ir::Float::F128);
5779        let area = varargs::Area::of(self.conv);
5780        let load = |ty: Type| (self.selector.abi.load)(ty).expect("a load of a whole register");
5781        let (load_word, load_vector) = (load(word), load(vector));
5782        let mut read = |ty: Type, head: &str, class: RegClass, at: u32| {
5783            let reg = self.out.new_vreg(class);
5784            let opcode = mir::Opcode::new(self.names.intern(head));
5785            let at = i32::try_from(at).expect("a block of under two gigabytes");
5786            let mem = mir::Mem::at(mir::Operand::read(saved, self.gpr)).plus(at);
5787            self.out.build(block, opcode).at(span).def(reg, class).mem(mem).finish();
5788            abi::Passing { ty, reg, abi: Abi::Plain }
5789        };
5790        let sse = self.conv.sse_class;
5791        let gpr = self.gpr;
5792        let mut args = Vec::with_capacity(15);
5793        for (float, ty, head, class) in
5794            [(false, word, load_word, gpr), (true, vector, load_vector, sse)]
5795        {
5796            for index in 0..area.holds(float) {
5797                let at = APPLY_REGS + area.starts_at(float) + index * area.stride(float);
5798                args.push(read(ty, head, class, at));
5799            }
5800        }
5801        if size > 0 {
5802            let memory = read(word, load_word, gpr, 0);
5803            let object =
5804                Abi::ByVal { size: u64::from(size), align: 8, drains: rucc_ir::Drains::Nothing };
5805            args.push(abi::Passing { abi: object, ..memory });
5806        }
5807        let returns = [word, word, vector, vector];
5808        let what = abi::Calling {
5809            callee: abi::Callee::Through(function),
5810            args: &args,
5811            returns: &returns,
5812            variadic: true,
5813            named: args.len(),
5814            at: span,
5815        };
5816        let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
5817            .map_err(|refused| Unsupported::Call { inst, refused })?;
5818        let calls = &mut self.stack.calls;
5819        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
5820
5821        let back = self.stack.locals.len();
5822        self.stack.locals.push(Local { size: APPLY_BACK, align: varargs::VECTOR_SLOT });
5823        let base = self.frame_address(block, back);
5824        for ((&reg, ty), at) in made.results.iter().zip(returns).zip([0, 8, 16, 32]) {
5825            let class = if ty == word { gpr } else { sse };
5826            let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5827            let store = mir::Opcode::new(self.names.intern(head));
5828            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(at);
5829            self.out.build(block, store).at(span).uses(reg, class).mem(mem).finish();
5830        }
5831        let answer = self.frame_address(block, back);
5832        self.regs[result.index()] = Some(answer);
5833        Ok(())
5834    }
5835
5836    /// The address of one of the function's stack objects, in a fresh register.
5837    ///
5838    /// Written with nothing in its displacement, because where an object is in a frame is not known
5839    /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
5840    fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
5841        self.frame_address_plus(out, local, 0)
5842    }
5843
5844    /// The address some way into a local, which the frame finishes the same way, adding where the
5845    /// local is to what is already there.
5846    fn frame_address_plus(&mut self, out: mir::Block, local: usize, plus: u32) -> mir::Reg {
5847        let reg = self.out.new_vreg(self.gpr);
5848        let lea = self.named(self.selector.frame.lea);
5849        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
5850        let plus = i32::try_from(plus).expect("an offset into a local under two gigabytes");
5851        let mem = mir::Mem::at(sp).plus(plus);
5852        let made = self.out.build(out, lea).def(reg, self.gpr).mem(mem).finish();
5853        self.stack.addresses.push((made, local));
5854        reg
5855    }
5856
5857    /// Whether an instruction is one no machine instruction is written for where it stands.
5858    ///
5859    /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
5860    /// written where a register for it is first wanted rather than where the IR put it, and every
5861    /// reader of one may have folded it into an immediate, in which case nowhere is the right
5862    /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
5863    /// and leaves, and it is appended to every block with no successors long after this has
5864    /// finished, so a return with a value is one instruction here and a return without one is
5865    /// none. Unless the value went back through memory, in which case there is something to put
5866    /// somewhere after all and the IR does not carry it: the address the caller handed over has
5867    /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
5868    ///
5869    /// An unconditional jump is the third, and there is even less of it: the edge is on the
5870    /// block, and whether the block it goes to is the next one and needs no jump at all is the
5871    /// block layout's answer rather than this one's.
5872    ///
5873    /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
5874    /// the `unreachable` terminator the front end puts at the end of a function whose body can run
5875    /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
5876    /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
5877    /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
5878    /// successors, so the epilogue lands at the end of it the way it does on any other block that
5879    /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
5880    /// the assembler puts next.
5881    fn writes_nothing(&self, inst: Inst) -> bool {
5882        let data = &self.source[inst];
5883        match data.opcode {
5884            Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
5885            Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
5886            _ => false,
5887        }
5888    }
5889
5890    /// What every instruction in one block matched, with a set of values nobody may take.
5891    ///
5892    /// Backwards, because an instruction that has been folded into a later one does not get to
5893    /// fold anything into itself: the rule that took it only reached one level down, so what is
5894    /// under it is not in the term the matcher saw and cannot be replaced.
5895    fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
5896        let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
5897        let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
5898        let mut folded: Vec<Inst> = Vec::new();
5899        for (index, &inst) in insts.iter().enumerate().rev() {
5900            if folded.contains(&inst) {
5901                continue;
5902            }
5903            if let Some((plan, matched)) = self.select(inst, refused) {
5904                folded.extend(self.folds(inst, plan));
5905                found[index] = Some(matched);
5906                plans[index] = Some(plan);
5907            }
5908        }
5909        Decided { found, plans, folded }
5910    }
5911
5912    /// A value some of its readers took and some of them did not, which is the one case folding
5913    /// buys nothing.
5914    ///
5915    /// Folding does not delete the instruction that computed a value for anybody else, so a
5916    /// reader that did not take it still needs it in a register and the instruction stays. The
5917    /// reader that did take it now does that work again. Either all of them take it, in which
5918    /// case nothing is left to read it and the instruction goes, or none of them do.
5919    ///
5920    /// The count is over the whole function rather than over the block, since a value read from
5921    /// another block is read from a register there whatever this block decides. An instruction
5922    /// built by name rather than matched, a call being the one that matters, has no plan and so
5923    /// takes nothing, which is the right answer for it as well.
5924    fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
5925        let mut taken = vec![0u32; self.uses.len()];
5926        for (&inst, plan) in insts.iter().zip(plans) {
5927            let Some(plan) = plan else { continue };
5928            let args = &self.source[self.source[inst].args];
5929            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
5930                if plan[index] == Shown::Expand {
5931                    taken[arg.index()] += 1;
5932                }
5933            }
5934        }
5935        for (&inst, plan) in insts.iter().zip(plans) {
5936            let Some(plan) = plan else { continue };
5937            let args = &self.source[self.source[inst].args];
5938            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
5939                if plan[index] == Shown::Expand && taken[arg.index()] < self.uses[arg.index()] {
5940                    return Some(arg);
5941                }
5942            }
5943        }
5944        None
5945    }
5946
5947    /// The rule that fires on an instruction, and what it bound.
5948    ///
5949    /// The plans are tried in order and the first that matches wins, which is the maximal munch
5950    /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
5951    /// that offers less.
5952    fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
5953        for plan in self.plans(inst, refused) {
5954            let terms = Terms::new(self.source, inst, plan);
5955            if let Some(matched) = self.selector.table.find(&terms, Term::Root) {
5956                return Some((plan, matched));
5957            }
5958        }
5959        None
5960    }
5961
5962    /// Every way this instruction can be shown to the matcher, most offered first.
5963    fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> Vec<Plan> {
5964        let args = &self.source[self.source[inst].args];
5965        let mut plans = vec![PLAIN];
5966        for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
5967            let mut ways = Vec::new();
5968            if self.foldable(inst, arg, refused) {
5969                ways.push(Shown::Expand);
5970            }
5971            if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
5972                ways.push(Shown::Const);
5973            }
5974            ways.push(Shown::Reg);
5975            plans = plans
5976                .into_iter()
5977                .flat_map(|plan| {
5978                    ways.iter().map(move |&way| {
5979                        let mut next = plan;
5980                        next[index] = way;
5981                        next
5982                    })
5983                })
5984                .collect();
5985        }
5986        plans
5987    }
5988
5989    /// Whether an operand may be shown as the instruction that computed it.
5990    ///
5991    /// It has to be in the same block, because a rule that folds one instruction into another
5992    /// moves the work to where the second one is. It has to be something rather than a block
5993    /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
5994    /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
5995    /// question is asked here: this says yes to a value with any number of readers, and a value
5996    /// only some of them could take is refused after the fact and asked again.
5997    ///
5998    /// A value with several readers used to be refused outright, on the reasoning that folding
5999    /// does not delete the instruction for anybody else. That reasoning is about the set of
6000    /// readers and was being applied to one reader at a time, which is stricter than it needs to
6001    /// be: when every reader takes it there is nobody left to read it and the instruction goes.
6002    /// An address a store and a load share is the shape that matters, since a memory operand has
6003    /// room for the whole of it and both readers have a memory operand.
6004    fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
6005        let Def::Result { inst, .. } = self.source[value].def else { return false };
6006        if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
6007            return false;
6008        }
6009        self.source.block_of(inst).is_some()
6010            && self.source.block_of(inst) == self.source.block_of(into)
6011    }
6012
6013    /// The instructions a match folded into the one it matched.
6014    ///
6015    /// The plan is what says this, not the bindings: a binding is a register or a number either
6016    /// way, and an operand shown as the instruction that computed it is one no rule could have
6017    /// matched without taking that instruction, because the plan offered the matcher nothing
6018    /// else to call it.
6019    fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
6020        let args = &self.source[self.source[inst].args];
6021        args.iter()
6022            .take(MAX_ARGS)
6023            .enumerate()
6024            .filter(|&(index, _)| plan[index] == Shown::Expand)
6025            .filter_map(|(_, &arg)| match self.source[arg].def {
6026                Def::Result { inst, .. } => Some(inst),
6027                Def::Param { .. } => None,
6028            })
6029            .collect()
6030    }
6031
6032    /// What the IR instruction said about itself that the machine instruction has to keep saying.
6033    ///
6034    /// One flag today. `volatile` says the access happens exactly once and is never moved or
6035    /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
6036    /// one are the same instruction over the same address, so a pass that puts two accesses
6037    /// together would put these together too. Carried rather than checked here, because the pass
6038    /// that has to refuse is a long way down and this is the last place the answer is known.
6039    ///
6040    /// The instructions this compiler writes for itself get nothing, which is the right answer
6041    /// for all of them: a prologue, a spill and the moves around a call were asked for by the
6042    /// machine rather than by the program.
6043    ///
6044    /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
6045    /// the two ends of a `long double` copy that are the program's own memory, and the compare
6046    /// and exchange and the read modify write. An `asm` statement does not, and it is the one
6047    /// exception on purpose. What the flag says there is that the statement stays even when
6048    /// nothing reads what it wrote, which is a different sentence about a different thing, and
6049    /// every `asm` is already fixed where it stands whether the word was written or not.
6050    fn carried(&self, inst: Inst) -> mir::Flags {
6051        if self.source[inst].flags.contains(Flags::VOLATILE) {
6052            mir::Flags::VOLATILE
6053        } else {
6054            mir::Flags::NONE
6055        }
6056    }
6057
6058    /// Build the machine instructions a match calls for.
6059    fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
6060        let rule: &Rule = self.selector.table.rule(matched);
6061        self.build(inst, rule.replacement, 0, &matched.bindings, true).map(|_| ())
6062    }
6063
6064    /// Build the machine term that starts at `at`, and give back the position after it and the
6065    /// register it wrote, if it wrote one.
6066    ///
6067    /// The outermost term computes what the IR instruction does, so what it writes is the
6068    /// register of the instruction's result. A term inside another is a step on the way and
6069    /// writes a register of its own, which the term around it then reads. Its operands are read
6070    /// before it is built and it is built before the term around it, so the instructions come
6071    /// out in the order the values are needed.
6072    fn build(
6073        &mut self,
6074        inst: Inst,
6075        pieces: &'static [Piece],
6076        at: usize,
6077        bindings: &[Term],
6078        outermost: bool,
6079    ) -> Result<(usize, Option<mir::Reg>), Unsupported> {
6080        let Some(Piece::App { head, arity }) = pieces.get(at) else {
6081            return Err(self.unsupported(inst));
6082        };
6083        let opcode =
6084            head.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
6085        let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
6086
6087        let mut read = Read::default();
6088        let mut at = at + 1;
6089        for _ in 0..*arity {
6090            at = self.read(inst, pieces, at, bindings, &mut read)?;
6091        }
6092
6093        let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
6094        if descs.len() - writes != read.regs.len() {
6095            return Err(self.unsupported(inst));
6096        }
6097
6098        // The first thing the instruction writes is what it computes, and any others are
6099        // registers the machine destroys on the way, which are fresh because nothing else is in
6100        // them and nothing reads them. An instruction that writes nothing at all is one whose
6101        // whole purpose is its effect, which is what a store is, and there is no result to put
6102        // anywhere.
6103        let mut regs = Vec::new();
6104        if writes > 0 {
6105            // A term inside another computes a step rather than the result, into a register only
6106            // the term around it reads.
6107            let first = match outermost {
6108                true => {
6109                    let result =
6110                        self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
6111                    self.new_reg(result)
6112                }
6113                false => self.out.new_vreg(descs[0].class),
6114            };
6115            regs.push(first);
6116            // The rest are the registers the machine destroys on the way, and the class each is in
6117            // is the one the instruction's description gives it rather than a guess, so that an
6118            // instruction that wrecks a register in the other file says so.
6119            regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
6120        } else if !outermost || self.source[inst].first_result.is_some() {
6121            // A rule that throws away a value the IR gave a name to would leave every reader of
6122            // that name with nothing to read, so it is a rule this and the target disagree about.
6123            // So is a term inside another that writes nothing for the one around it to read.
6124            return Err(self.unsupported(inst));
6125        }
6126        let written = regs.first().copied();
6127        regs.extend(read.regs.iter().copied());
6128
6129        let block = self.at.expect("a block is being filled");
6130        let opcode = mir::Opcode::new(self.names.intern(head));
6131        let (span, flags) = (self.source.span(inst), self.carried(inst));
6132        let mut build = self.out.build(block, opcode).at(span).flags(flags);
6133        for (desc, reg) in descs.iter().zip(regs) {
6134            let operand = mir::Operand {
6135                reg,
6136                class: desc.class,
6137                role: desc.role,
6138                constraint: desc.constraint,
6139            };
6140            build = build.operand(operand);
6141        }
6142        if let Some(mem) = read.mem {
6143            build = build.mem(mem);
6144        }
6145        if let Some(imm) = read.imm {
6146            build = build.imm(imm);
6147        }
6148        build.finish();
6149        Ok((at, written))
6150    }
6151
6152    /// Read one argument of a replacement, which is a register, a number, an address or another
6153    /// machine term.
6154    ///
6155    /// Gives back the position after it, because a replacement is flat and an address or a term
6156    /// takes arguments of its own. A machine term is built on the spot, and what is read is the
6157    /// register it wrote.
6158    fn read(
6159        &mut self,
6160        inst: Inst,
6161        pieces: &'static [Piece],
6162        at: usize,
6163        bindings: &[Term],
6164        out: &mut Read,
6165    ) -> Result<usize, Unsupported> {
6166        match pieces.get(at) {
6167            Some(Piece::Int(value)) => {
6168                out.imm = i64::try_from(*value).ok();
6169                Ok(at + 1)
6170            }
6171            // A number the rule worked out of the ones it matched rather than one it wrote down,
6172            // which is an immediate once it has been worked out and is read here as one. It gives
6173            // nothing back when a binding it reads is a register, and a replacement that cannot be
6174            // built is a rule this file and the matcher disagree about, which is what `unsupported`
6175            // is for.
6176            Some(Piece::Computed { work, .. }) => {
6177                let matched: Vec<Option<i128>> = bindings
6178                    .iter()
6179                    .map(|term| match *term {
6180                        Term::Num(value) => Some(value),
6181                        _ => None,
6182                    })
6183                    .collect();
6184                let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
6185                out.imm = i64::try_from(number).ok();
6186                Ok(at + 1)
6187            }
6188            Some(Piece::Var { index, .. }) => {
6189                match bindings.get(*index) {
6190                    Some(&Term::Reg(value)) => {
6191                        let reg = self.reg_of(value)?;
6192                        out.regs.push(reg);
6193                    }
6194                    Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
6195                    // A pattern binds a register or a number and nothing else, so this is a
6196                    // rule the matcher and this file disagree about.
6197                    _ => return Err(self.unsupported(inst)),
6198                }
6199                Ok(at + 1)
6200            }
6201            Some(Piece::App { head, .. }) if (self.selector.address)(head).is_none() => {
6202                let (next, reg) = self.build(inst, pieces, at, bindings, false)?;
6203                out.regs.push(reg.ok_or_else(|| self.unsupported(inst))?);
6204                Ok(next)
6205            }
6206            Some(Piece::App { head, arity }) => {
6207                let kind = (self.selector.address)(head).ok_or_else(|| self.unsupported(inst))?;
6208                let mut inner = Read::default();
6209                let mut next = at + 1;
6210                for _ in 0..*arity {
6211                    next = self.read(inst, pieces, next, bindings, &mut inner)?;
6212                }
6213                let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
6214                out.mem = Some(mem);
6215                Ok(next)
6216            }
6217            None => Err(self.unsupported(inst)),
6218        }
6219    }
6220
6221    /// The register a value is in, materializing it if it is a constant that has not been put in
6222    /// one yet.
6223    ///
6224    /// A constant is written where it is wanted rather than where the IR defined it, and where it
6225    /// is wanted is a block that need not be the one the IR defined it in. So the register holding
6226    /// one is only good inside the block it was written into, and a second block that wants the
6227    /// same constant gets its own. Anything else is a register read where nothing wrote it: the
6228    /// IR guarantees a definition dominates its uses, and this moved the definition.
6229    ///
6230    /// Writing the number again is also the right answer and not merely the safe one. It is one
6231    /// instruction that reads nothing, which is cheaper than holding a register live across a
6232    /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
6233    fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
6234        let constant = match self.source[value].def {
6235            Def::Result { inst, .. } => {
6236                (self.source[inst].opcode == Opcode::IConst).then_some(inst)
6237            }
6238            Def::Param { .. } => None,
6239        };
6240        let here = self.at.expect("a block is being filled");
6241        if let Some(reg) = self.regs[value.index()] {
6242            if constant.is_none() || self.written[value.index()] == Some(here) {
6243                return Ok(reg);
6244            }
6245        }
6246        if let Some(inst) = constant {
6247            // Cleared so that the register the constant is written into is a new one rather than
6248            // the one the block above wrote, which is still being read up there.
6249            self.regs[value.index()] = None;
6250            // Nothing is refused here. A constant is written on its own, out of the loop over the
6251            // block, and the operands of the rule that writes one are the number and nothing else.
6252            let matched = self
6253                .select(inst, &HashSet::new())
6254                .map(|(_, matched)| matched)
6255                .ok_or_else(|| self.unsupported(inst))?;
6256            self.emit(inst, &matched)?;
6257            // The same mark the loop over the instructions makes, and it has to be made here as
6258            // well because this is the only place a constant is ever selected: the loop skips one
6259            // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
6260            // would be reported as a rule nothing reaches.
6261            self.fired.mark(matched.rule);
6262            self.written[value.index()] = Some(here);
6263            return Ok(self.regs[value.index()].expect("a constant is written into a register"));
6264        }
6265        Ok(self.new_reg(value))
6266    }
6267
6268    /// Which register file a value of that type lives in.
6269    ///
6270    /// The vector one for the two float widths the machine has scalar instructions for and for the
6271    /// one it only moves, and the general purpose one for everything else. An eighty bit `long
6272    /// double` is in neither, and it is here rather than in the vector class on purpose: it would
6273    /// be put in a register that cannot hold it, and there is no rule that names one, so the
6274    /// instruction computing it is reported. The wrong class would make that a wrong program
6275    /// instead of a refused one.
6276    ///
6277    /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
6278    /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
6279    /// what the class buys is the moves: a register that holds the whole value is a register a
6280    /// spill, a reload and a copy are each one instruction for.
6281    fn class_of(&self, ty: Type) -> RegClass {
6282        if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
6283    }
6284
6285    /// A fresh register for a value, which is what the instruction computing it writes.
6286    ///
6287    /// Any declaration the value is a value of comes with it. Here rather than once at the end over
6288    /// the whole map, because a constant is written again in every block that wants one and the map
6289    /// only remembers the last of those registers, and a local held in a constant is a local that
6290    /// would otherwise be findable in one block of the function and nowhere else.
6291    fn new_reg(&mut self, value: Value) -> mir::Reg {
6292        if let Some(reg) = self.regs[value.index()] {
6293            return reg;
6294        }
6295        let reg = self.out.new_vreg(self.class_of(self.source[value].ty));
6296        self.regs[value.index()] = Some(reg);
6297        let source = self.source;
6298        for decl in source.value_decls(value) {
6299            self.out.named.push((decl, reg));
6300        }
6301        reg
6302    }
6303
6304    fn unsupported(&self, inst: Inst) -> Unsupported {
6305        let data = &self.source[inst];
6306        Unsupported::Inst {
6307            inst,
6308            term: Terms::new(self.source, inst, PLAIN).name(inst),
6309            opcode: data.opcode,
6310            ty: data.first_result.map(|result| self.source[result].ty),
6311        }
6312    }
6313}
6314
6315/// What the arguments of one replacement came to.
6316#[derive(Debug, Default)]
6317struct Read {
6318    regs: Vec<mir::Reg>,
6319    imm: Option<i64>,
6320    mem: Option<mir::Mem>,
6321}
6322
6323/// The addressing mode an address constructor's arguments make.
6324///
6325/// One arm per constructor rather than a question asked of the kind, because what the arguments
6326/// mean is the whole of what tells the four apart: the same register is a base in one and an
6327/// index in another, and the same constant is a scale in one and a displacement in another.
6328fn address(kind: Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
6329    let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
6330    match kind {
6331        Address::BaseIndexScale => {
6332            let base = regs.next()?;
6333            let index = regs.next()?;
6334            Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
6335        }
6336        Address::IndexScale => Some(mir::Mem {
6337            base: None,
6338            index: Some(regs.next()?),
6339            scale: u8::try_from(read.imm?).ok()?,
6340            disp: 0,
6341            symbol: None,
6342            block: None,
6343            table: None,
6344            reach: mir::Reach::Itself,
6345            segment: None,
6346        }),
6347        Address::Base => Some(mir::Mem::at(regs.next()?)),
6348        // The rule that writes this has a guard saying the constant fits, so a displacement that
6349        // does not is a rule and a target that disagree rather than a program this cannot compile.
6350        Address::BaseOffset => {
6351            Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
6352        }
6353    }
6354}
6355
6356#[cfg(test)]
6357mod tests {
6358    use rucc_ir::{
6359        AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
6360    };
6361    use rucc_regalloc::assign::Env;
6362    use rucc_target::x86_64::{FRAME, REGS, SYSV};
6363
6364    use super::*;
6365    use crate::finish::{Convention, finish};
6366    use crate::frame::{Frame, Incoming, Layout};
6367    use crate::select::x86_64::SELECTOR;
6368
6369    /// A function of as many 64 bit parameters as the test wants, and the block they are in.
6370    fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6371        let mut names = Interner::new();
6372        let mut func = Func::new(names.intern("f"), Signature::new());
6373        let block = func.create_block();
6374        let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
6375        (names, func, block, values)
6376    }
6377
6378    /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
6379    /// Neither field reaches selection, which is the point of saying it once here.
6380    fn plain() -> MemInfo {
6381        MemInfo {
6382            size: 0,
6383            align: 1,
6384            order: MemOrder::NotAtomic,
6385            tbaa: None,
6386            owns: 0,
6387            restrict: Restrict::NONE,
6388        }
6389    }
6390
6391    /// What the allocator is given: every integer register the convention offers except two, held
6392    /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
6393    /// somewhere to be read into. Which two does not matter, and holding back the last two the
6394    /// convention would reach for leaves every expectation below unchanged.
6395    fn env() -> Env {
6396        const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
6397        let order: Vec<PhysReg> =
6398            SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
6399        Env::new().with(x86_64::GPR, &order, &SCRATCH)
6400    }
6401
6402    /// The machine IR text a function lowers to.
6403    fn lower(names: &mut Interner, source: &Func) -> String {
6404        let out = func(source, names, &SELECTOR, &SYSV, &Elsewhere::default())
6405            .expect("every instruction has a rule");
6406        mir::print_func(&out.func, names, &REGS)
6407    }
6408
6409    /// The same function lowered for AArch64, which is the first thing this file writes for a
6410    /// machine other than x86-64. Nothing past selection runs here, so what is checked is that the
6411    /// arguments, the rule and the return all come out named for the machine that was asked for.
6412    #[test]
6413    fn an_addition_lowers_for_aarch64_with_its_own_names() {
6414        let i32 = Type::int(32);
6415        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6416        let mut build = Builder::new(&mut func, block);
6417        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
6418        build.ret(&[sum]);
6419
6420        let conv = &aarch64::AAPCS64;
6421        let selector = &crate::select::aarch64::SELECTOR;
6422        let out = super::func(&func, &mut names, selector, conv, &Elsewhere::default())
6423            .expect("an addition and a return have AArch64 rules");
6424        let text = mir::print_func(&out.func, &names, &aarch64::REGS);
6425        assert!(!text.contains("x64."), "{text}");
6426        assert!(text.contains("= a64.arg_val_32"), "{text}");
6427        assert!(text.contains("= a64.add_rr_32 %0, %1"), "{text}");
6428        assert!(text.contains("a64.ret_val_32 %2"), "{text}");
6429    }
6430
6431    /// Lowers one function for AArch64 and prints it, or says why it could not.
6432    fn lower_a64(names: &mut Interner, func: &Func) -> Result<String, String> {
6433        let conv = &aarch64::AAPCS64;
6434        let selector = &crate::select::aarch64::SELECTOR;
6435        let out = super::func(func, names, selector, conv, &Elsewhere::default())
6436            .map_err(|why| why.to_string())?;
6437        Ok(mir::print_func(&out.func, names, &aarch64::REGS))
6438    }
6439
6440    /// Nothing reads AArch64 assembly back into instructions, so every template there is kept as
6441    /// its text. The operands are the instruction's own, with the output first and the inputs
6442    /// last, a hole in the text asks for the `w` or the `x` name of one, and a vector register the
6443    /// clobber list names is written by it as well as every register a call may leave anything in.
6444    #[test]
6445    fn a_template_on_aarch64_is_kept_as_text_with_its_operands_in_registers() {
6446        let (i32, i64) = (Type::int(32), Type::int(64));
6447        let (mut names, mut source, block, args) = blank(&[i32, i64]);
6448        let out = clobbering(
6449            &mut source,
6450            block,
6451            &mut names,
6452            "add %w0, %w1, #1\n\tstr %2, [sp]",
6453            "=r,r,r",
6454            "d8",
6455            &[args[0], args[1]],
6456            &[i32],
6457        );
6458        let produced = source[out].results().next().expect("one result");
6459        Builder::new(&mut source, block).ret(&[produced]);
6460
6461        // Forty one registers between the output and the inputs: `x0` to `x15`, the sixteen vector
6462        // registers a call does not keep, and `v8`, which is the one the program named.
6463        let text = lower_a64(&mut names, &source).expect("kept as text");
6464        assert!(text.contains("%2:gpr, early $x0, early $x1,"), "{text}");
6465        assert!(text.contains(
6466            "early $v31, early $v8 = a64.template %0, %1, \
6467             @add \u{1}r0w\u{2}, \u{1}r42w\u{2}, #1\n\tstr \u{1}r43x\u{2}, [sp]\n"
6468        ));
6469    }
6470
6471    /// A letter that means one thing on x86 and another on AArch64 is refused there rather than
6472    /// read as x86. `a` to `d` and `S` name one register each on x86 and nothing on AArch64.
6473    #[test]
6474    fn a_constraint_letter_the_two_machines_disagree_about_is_refused_on_aarch64() {
6475        let i64 = Type::int(64);
6476        for constraints in ["=a,r", "=r,S", "=r,c"] {
6477            let (mut names, mut source, block, args) = blank(&[i64]);
6478            let out = clobbering(
6479                &mut source,
6480                block,
6481                &mut names,
6482                "mov %0, %1",
6483                constraints,
6484                "",
6485                &[args[0]],
6486                &[i64],
6487            );
6488            let produced = source[out].results().next().expect("one result");
6489            Builder::new(&mut source, block).ret(&[produced]);
6490            let refused = lower_a64(&mut names, &source).expect_err(constraints);
6491            assert!(refused.contains("has an operand this cannot place"), "{refused}");
6492        }
6493    }
6494
6495    /// `Q` on AArch64 is memory addressed by one register, which is `[x3]` and is how an operand in
6496    /// memory is spelled there already.
6497    #[test]
6498    fn a_q_operand_on_aarch64_is_its_address_in_brackets() {
6499        let (i64, ptr) = (Type::int(64), Type::PTR);
6500        let (mut names, mut source, block, args) = blank(&[ptr]);
6501        let out =
6502            clobbering(&mut source, block, &mut names, "ldr %x0, %1", "=r,Q", "", &args, &[i64]);
6503        let produced = source[out].results().next().expect("one result");
6504        Builder::new(&mut source, block).ret(&[produced]);
6505        let text = lower_a64(&mut names, &source).expect("kept as text");
6506        assert!(text.contains("@ldr \u{1}r0x\u{2}, [\u{1}r"), "{text}");
6507    }
6508
6509    /// `w` on AArch64 is a vector register, named `v` with no modifier the way gcc names it and by
6510    /// its scalar view with one. An integer asked for in one is refused, since it would need a move
6511    /// into that file first.
6512    #[test]
6513    fn a_vector_operand_on_aarch64_is_in_the_vector_file() {
6514        let f64 = Type::float(rucc_ir::Float::F64);
6515        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6516        let out = clobbering(
6517            &mut source,
6518            block,
6519            &mut names,
6520            "fadd %d0, %d1, %d2\n\tmov %0.16b, %0.16b",
6521            "=w,w,w",
6522            "",
6523            &[args[0], args[1]],
6524            &[f64],
6525        );
6526        let produced = source[out].results().next().expect("one result");
6527        Builder::new(&mut source, block).ret(&[produced]);
6528        let text = lower_a64(&mut names, &source).expect("kept as text");
6529        assert!(text.contains("%2:fpr, early $x0,"), "{text}");
6530        assert!(text.contains("@fadd \u{1}r0d\u{2}, \u{1}r"), "{text}");
6531        assert!(text.contains("\n\tmov \u{1}r0v\u{2}.16b, \u{1}r0v\u{2}.16b\n"), "{text}");
6532
6533        let i64 = Type::int(64);
6534        let (mut names, mut source, block, args) = blank(&[i64]);
6535        let out =
6536            clobbering(&mut source, block, &mut names, "fmov %d0, %d1", "=w,w", "", &args, &[i64]);
6537        let produced = source[out].results().next().expect("one result");
6538        Builder::new(&mut source, block).ret(&[produced]);
6539        assert!(lower_a64(&mut names, &source).is_err());
6540    }
6541
6542    #[test]
6543    fn an_addition_of_two_registers_is_one_instruction() {
6544        let i32 = Type::int(32);
6545        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6546        let mut build = Builder::new(&mut func, block);
6547        build.binary(Opcode::Add, args[0], args[1], Flags::default());
6548
6549        assert_eq!(
6550            lower(&mut names, &func),
6551            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6552             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
6553        );
6554    }
6555
6556    #[test]
6557    fn a_constant_operand_becomes_an_immediate() {
6558        let i32 = Type::int(32);
6559        let (mut names, mut func, block, args) = blank(&[i32]);
6560        let mut build = Builder::new(&mut func, block);
6561        let seven = build.iconst(i32, 7);
6562        build.binary(Opcode::Add, args[0], seven, Flags::default());
6563
6564        // The constant is in the instruction and nothing was written to hold it, which is what
6565        // materializing one where a register for it is wanted buys.
6566        assert_eq!(
6567            lower(&mut names, &func),
6568            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6569             %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
6570        );
6571    }
6572
6573    #[test]
6574    fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
6575        let i64 = Type::int(64);
6576        let (mut names, mut func, block, args) = blank(&[i64]);
6577        let mut build = Builder::new(&mut func, block);
6578        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
6579        build.binary(Opcode::Add, args[0], big, Flags::default());
6580
6581        // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
6582        // turns a number this wide down, so it does not fire, and the next way of showing the
6583        // operand puts it in a register.
6584        assert_eq!(
6585            lower(&mut names, &func),
6586            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6587             %1:gpr = x64.mov_ri_64 2147483648\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
6588        );
6589    }
6590
6591    #[test]
6592    fn an_index_calculation_folds_into_an_address() {
6593        let i64 = Type::int(64);
6594        let (mut names, mut func, block, args) = blank(&[i64, i64]);
6595        let mut build = Builder::new(&mut func, block);
6596        let four = build.iconst(i64, 4);
6597        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6598        build.binary(Opcode::Add, args[0], scaled, Flags::default());
6599
6600        // Three IR instructions and one machine instruction. The multiply is gone because the
6601        // rule that matched reached down and took it.
6602        assert_eq!(
6603            lower(&mut names, &func),
6604            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6605             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
6606        );
6607    }
6608
6609    #[test]
6610    fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
6611        let i64 = Type::int(64);
6612        let (mut names, mut func, block, args) = blank(&[i64, i64]);
6613        let mut build = Builder::new(&mut func, block);
6614        let four = build.iconst(i64, 4);
6615        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6616        let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
6617        build.binary(Opcode::Add, first, scaled, Flags::default());
6618
6619        // Both readers have room for a scaled index, so both of them take it and nothing is left
6620        // to read the multiply. Three IR instructions become two machine ones, where refusing to
6621        // fold into either reader would have left three.
6622        assert_eq!(
6623            lower(&mut names, &func),
6624            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6625             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n    \
6626             %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
6627        );
6628    }
6629
6630    #[test]
6631    fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
6632        let i64 = Type::int(64);
6633        let (mut names, mut func, block, args) = blank(&[i64, i64]);
6634        let mut build = Builder::new(&mut func, block);
6635        let four = build.iconst(i64, 4);
6636        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6637        build.binary(Opcode::Add, args[0], scaled, Flags::default());
6638        build.store(scaled, args[0], plain(), Flags::default());
6639
6640        // The addition has room for the multiply and the store does not: what a store writes is
6641        // a register, and no rule reaches through it. Folding into the addition alone would
6642        // leave the multiply where it is for the store to read and do the work twice, so the
6643        // multiply is put back and both readers read the register it wrote.
6644        let text = lower(&mut names, &func);
6645        assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
6646        assert!(text.contains("x64.add_rr_64"), "{text}");
6647    }
6648
6649    #[test]
6650    fn a_shift_by_a_register_asks_for_it_in_cl() {
6651        let i32 = Type::int(32);
6652        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6653        let mut build = Builder::new(&mut func, block);
6654        build.binary(Opcode::Shl, args[0], args[1], Flags::default());
6655
6656        // The fixed register is not in the rule. It is what the target says the instruction does
6657        // with its operands, and the allocator is what will act on it.
6658        let text = lower(&mut names, &func);
6659        assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
6660    }
6661
6662    #[test]
6663    fn a_division_names_the_registers_and_the_register_it_destroys() {
6664        let i32 = Type::int(32);
6665        let (mut names, mut func, block, args) = blank(&[i32, i32]);
6666        let mut build = Builder::new(&mut func, block);
6667        build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
6668
6669        // Two definitions, because a division writes the remainder whether anybody wanted it or
6670        // not, and the second one is early because it is destroyed before the operands are read.
6671        let text = lower(&mut names, &func);
6672        assert!(
6673            text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
6674            "{text}"
6675        );
6676    }
6677
6678    #[test]
6679    fn a_load_reads_through_the_register_the_address_is_in() {
6680        let i64 = Type::int(64);
6681        let (mut names, mut func, block, args) = blank(&[i64]);
6682        let mut build = Builder::new(&mut func, block);
6683        build.load(Type::int(32), args[0], plain(), Flags::default());
6684
6685        assert_eq!(
6686            lower(&mut names, &func),
6687            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6688             %1:gpr = x64.mov_rm_32 [%0]\n}\n"
6689        );
6690    }
6691
6692    #[test]
6693    fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
6694        let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
6695        let mut build = Builder::new(&mut func, block);
6696        build.store(args[0], args[1], plain(), Flags::default());
6697
6698        // The value is the first parameter and the address is the second, and the instruction
6699        // takes them the other way round. Getting that backwards would compile to a store of the
6700        // address into the value, which is a program that runs and does the wrong thing.
6701        assert_eq!(
6702            lower(&mut names, &func),
6703            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6704             %1:gpr($rsi) = x64.arg_val_64\n    x64.mov_mr_32 %0, [%1]\n}\n"
6705        );
6706    }
6707
6708    #[test]
6709    fn an_address_with_a_constant_added_folds_into_the_access() {
6710        let i64 = Type::int(64);
6711        let (mut names, mut func, block, args) = blank(&[i64]);
6712        let mut build = Builder::new(&mut func, block);
6713        let twelve = build.iconst(i64, 12);
6714        let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
6715        build.load(Type::int(64), field, plain(), Flags::default());
6716
6717        // Two IR instructions and one machine instruction, which is what every read of a field
6718        // of a structure comes to.
6719        assert_eq!(
6720            lower(&mut names, &func),
6721            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6722             %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
6723        );
6724    }
6725
6726    #[test]
6727    fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
6728        let i64 = Type::int(64);
6729        let (mut names, mut func, block, args) = blank(&[i64]);
6730        let mut build = Builder::new(&mut func, block);
6731        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
6732        let far = build.binary(Opcode::Add, args[0], big, Flags::default());
6733        build.load(Type::int(32), far, plain(), Flags::default());
6734
6735        // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
6736        // this down, so the addition stays and the load reads through what it produced. Nobody
6737        // wrote that fallback: it is the next way of showing the operand.
6738        let text = lower(&mut names, &func);
6739        assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
6740        assert!(text.contains("x64.add_rr_64"), "{text}");
6741    }
6742
6743    #[test]
6744    fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
6745        let i64 = Type::int(64);
6746        let (mut names, mut func, block, args) = blank(&[i64, i64]);
6747        let mut build = Builder::new(&mut func, block);
6748        let got = build.load(Type::int(8), args[0], plain(), Flags::default());
6749        build.store(got, args[1], plain(), Flags::default());
6750
6751        // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
6752        // most one memory operand, and there is no rule that takes two, so the load is left where
6753        // it is and the store reads the register it wrote.
6754        assert_eq!(
6755            lower(&mut names, &func),
6756            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6757             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.mov_rm_8 [%0]\n    \
6758             x64.mov_mr_8 %2, [%1]\n}\n"
6759        );
6760    }
6761
6762    #[test]
6763    fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
6764        let i64 = Type::int(64);
6765        let (mut names, mut source, block, args) = blank(&[i64]);
6766        let mut build = Builder::new(&mut source, block);
6767        build.load(Type::int(128), args[0], plain(), Flags::default());
6768
6769        // The width is the whole of what is wrong here, so the width is in the message: `load`
6770        // on its own is written about at every other width and would send a reader looking in
6771        // the wrong place.
6772        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6773            .expect_err("nothing loads 128 bits");
6774        assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
6775    }
6776
6777    #[test]
6778    fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
6779        let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
6780        let mut build = Builder::new(&mut func, block);
6781        build.ret(&[args[0]]);
6782
6783        // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
6784        // is what the target says the instruction does with its operand, and the allocator is
6785        // what will act on it. There is no `ret` here, because giving the frame back has to
6786        // happen between this and leaving and the frame is not worked out yet.
6787        assert_eq!(
6788            lower(&mut names, &func),
6789            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6790             x64.ret_val_32 %0($rax)\n}\n"
6791        );
6792    }
6793
6794    #[test]
6795    fn a_return_of_two_values_asks_for_the_second_register_as_well() {
6796        let i64 = Type::int(64);
6797        let (mut names, mut func, block, args) = blank(&[i64, i64]);
6798        let mut build = Builder::new(&mut func, block);
6799        build.ret(&[args[0], args[1]]);
6800
6801        // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
6802        // halves are integers, so the second is in the second integer return register, and both
6803        // pseudos say so the same way the one for a single value does.
6804        assert_eq!(
6805            lower(&mut names, &func),
6806            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6807             %1:gpr($rsi) = x64.arg_val_64\n    x64.ret_val_64 %0($rax)\n    \
6808             x64.ret_val2_64 %1($rdx)\n}\n"
6809        );
6810    }
6811
6812    #[test]
6813    fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
6814        let f64 = Type::float(rucc_ir::Float::F64);
6815        let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
6816        let mut build = Builder::new(&mut func, block);
6817        build.ret(&[args[0], args[1]]);
6818
6819        // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
6820        // neither half is the second of anything and the `double` is in `xmm0` rather than in the
6821        // register a second `double` would have been in. Getting this wrong is not a crash: the
6822        // caller reads a register nobody wrote, and this is where that is ruled out.
6823        assert_eq!(
6824            lower(&mut names, &func),
6825            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
6826             %1:gpr($rdi) = x64.arg_val_64\n    x64.ret_val_f64 %0($xmm0)\n    \
6827             x64.ret_val_64 %1($rax)\n}\n"
6828        );
6829    }
6830
6831    #[test]
6832    fn two_of_the_same_file_back_take_the_first_two_of_it() {
6833        let f64 = Type::float(rucc_ir::Float::F64);
6834        let (mut names, mut func, block, args) = blank(&[f64, f64]);
6835        let mut build = Builder::new(&mut func, block);
6836        build.ret(&[args[0], args[1]]);
6837
6838        // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
6839        // above and counts in its own file the same way.
6840        assert_eq!(
6841            lower(&mut names, &func),
6842            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
6843             %1:xmm($xmm1) = x64.arg_val_f64\n    x64.ret_val_f64 %0($xmm0)\n    \
6844             x64.ret_val2_f64 %1($xmm1)\n}\n"
6845        );
6846    }
6847
6848    /// A function whose answer goes back through memory, with the pointer to the space for it in
6849    /// front of whatever else it takes. Only the signature says it is one.
6850    fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6851        let mut names = Interner::new();
6852        let sret = Abi::Sret { size: 32, align: 8 };
6853        let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
6854        signature.params.extend(params.iter().copied().map(Param::new));
6855        let mut func = Func::new(names.intern("f"), signature);
6856        let block = func.create_block();
6857        let space = func.append_param(block, Type::PTR);
6858        let values = std::iter::once(space)
6859            .chain(params.iter().map(|&ty| func.append_param(block, ty)))
6860            .collect();
6861        (names, func, block, values)
6862    }
6863
6864    #[test]
6865    fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
6866        let (mut names, mut func, block, _) = returning_through_memory(&[]);
6867        Builder::new(&mut func, block).ret(&[]);
6868
6869        // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
6870        // carries nothing, because the value went into the space the caller handed over, and the
6871        // document still says that address comes back in `rax`. Nothing in the IR says it, so the
6872        // convention says it, and the pseudo is the one any other pointer return would use.
6873        assert_eq!(
6874            lower(&mut names, &func),
6875            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6876             x64.ret_val_64 %0($rax)\n}\n"
6877        );
6878    }
6879
6880    #[test]
6881    fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
6882        let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
6883        let mut build = Builder::new(&mut func, block);
6884        build.store(args[1], args[0], plain(), Flags::default());
6885        build.ret(&[]);
6886
6887        // The register is a read at the end and not a move at the start, so it is live across
6888        // everything between the two and the allocator has to keep it somewhere. In a function
6889        // with a call in it that somewhere is a callee saved register, and the address comes back
6890        // into `rax` here rather than whatever the last instruction happened to leave there. That
6891        // is issue #333, and a store is enough to show the value outlives the entry block.
6892        let text = lower(&mut names, &func);
6893        assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
6894        assert!(text.ends_with("    x64.ret_val_64 %0($rax)\n}\n"), "{text}");
6895    }
6896
6897    #[test]
6898    fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
6899        let (mut names, mut func, block, args) = blank(&[Type::PTR]);
6900        let mut build = Builder::new(&mut func, block);
6901        build.store(args[0], args[0], plain(), Flags::default());
6902        build.ret(&[]);
6903
6904        // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
6905        // the one above and none of its meaning, and what tells them apart is the signature. A
6906        // `void` function leaves `rax` alone.
6907        assert!(!lower(&mut names, &func).contains("ret_val"));
6908    }
6909
6910    #[test]
6911    fn a_return_of_a_constant_puts_it_in_a_register_first() {
6912        let (mut names, mut func, block, _) = blank(&[]);
6913        let mut build = Builder::new(&mut func, block);
6914        let zero = build.iconst(Type::int(32), 0);
6915        build.ret(&[zero]);
6916
6917        // No rule returns an immediate, so the plan that offers one is turned down and the next
6918        // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
6919        // is appended to it.
6920        assert_eq!(
6921            lower(&mut names, &func),
6922            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
6923        );
6924    }
6925
6926    #[test]
6927    fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
6928        let (mut names, mut func, block, _) = blank(&[]);
6929        let mut build = Builder::new(&mut func, block);
6930        let zero = build.iconst(Type::int(32), 0);
6931        build.ret(&[zero]);
6932
6933        // The loop over the instructions passes a constant by, because a constant is written where
6934        // a register for it is first wanted rather than where the IR put it. So the only place a
6935        // rule about one is ever selected is the materialization, and a mark made in the loop
6936        // alone would report every rule about a constant as a rule nothing reaches.
6937        let out = super::func(&func, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6938            .expect("every instruction has a rule");
6939        let rules = &crate::select::x86_64::TABLE.rules;
6940        let fired: Vec<&str> = rules
6941            .iter()
6942            .enumerate()
6943            .filter(|(index, _)| out.fired.has(*index))
6944            .map(|(_, rule)| rule.pattern)
6945            .collect();
6946        assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
6947    }
6948
6949    #[test]
6950    fn a_return_of_nothing_is_no_instruction_at_all() {
6951        let (mut names, mut func, block, _) = blank(&[]);
6952        let mut build = Builder::new(&mut func, block);
6953        build.ret(&[]);
6954
6955        // Every part of leaving a function that returns nothing is the epilogue's, and the
6956        // epilogue goes in after allocation. A block with nothing in it is the right answer here
6957        // rather than a function that could not be lowered.
6958        assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
6959    }
6960
6961    #[test]
6962    fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
6963        let (mut names, mut source, block, _) = blank(&[]);
6964        let mut build = Builder::new(&mut source, block);
6965        let zero = build.iconst(Type::int(32), 0);
6966        build.ret(&[zero]);
6967
6968        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6969            .expect("every instruction has a rule")
6970            .func;
6971        let env = env();
6972        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6973        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
6974        finish(
6975            &mut out,
6976            &allocation,
6977            &frame,
6978            &Stack::default(),
6979            Convention::new(&SYSV, &FRAME),
6980            &mut names,
6981        );
6982
6983        // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
6984        // the value goes back, the target said where, and the allocator is what made it true. The
6985        // epilogue is what leaves, and this function needs no frame, so it is the return alone.
6986        //
6987        // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
6988        // so `rax` is the register the allocator tries first for the value the return reads, and
6989        // the constant is written straight into it.
6990        assert_eq!(
6991            mir::print_func(&out, &names, &REGS),
6992            "mfunc @f {\nblock0:\n    $rax = x64.mov_ri_32 0\n    \
6993             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
6994        );
6995    }
6996
6997    #[test]
6998    fn a_function_of_two_arguments_is_a_whole_function_now() {
6999        let i32 = Type::int(32);
7000        let (mut names, mut source, block, args) = blank(&[i32, i32]);
7001        let mut build = Builder::new(&mut source, block);
7002        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7003        build.ret(&[sum]);
7004
7005        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7006            .expect("every instruction has a rule")
7007            .func;
7008        let env = env();
7009        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7010        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7011        finish(
7012            &mut out,
7013            &allocation,
7014            &frame,
7015            &Stack::default(),
7016            Convention::new(&SYSV, &FRAME),
7017            &mut names,
7018        );
7019
7020        // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
7021        // side exists for. Before it there was no way to write one: the allocator refuses a
7022        // function whose entry block takes parameters, because there is no edge into an entry
7023        // block for the moves that give a block parameter its value to go on.
7024        //
7025        // One move, and it is the one the machine's addition needs rather than one the allocator
7026        // owes anybody. Each argument stays in the register it arrived in, because the pseudo
7027        // that defines it insists on that register and the allocator now tries it first, and the
7028        // sum stays in the register the addition wrote it to until the return reads it out. The
7029        // copy in front of a two address instruction is what makes its destination one of the
7030        // registers it reads, and the source operand keeps its own name because the destination
7031        // is what the encoder writes.
7032        assert_eq!(
7033            mir::print_func(&out, &names, &REGS),
7034            "mfunc @f {\nblock0:\n    $rdi($rdi) = x64.arg_val_32\n    \
7035             $rsi($rsi) = x64.arg_val_32\n    \
7036             $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n    $rax = x64.mov_rr_64 $rdi\n    \
7037             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
7038        );
7039    }
7040
7041    #[test]
7042    fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
7043        let i64 = Type::int(64);
7044        let (mut names, mut source, block, args) = blank(&[i64; 7]);
7045        let mut build = Builder::new(&mut source, block);
7046        build.ret(&[args[6]]);
7047
7048        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7049            .expect("the seventh is read from memory");
7050
7051        // SysV passes six integers in registers and the seventh in the caller's memory, so six of
7052        // these are pseudos that encode to nothing and the seventh is a load that encodes to real
7053        // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
7054        // yet. What the walk hands on is which instruction is waiting, and for how far up the
7055        // caller's argument area, which is the bottom of it because it is the first one there.
7056        assert_eq!(lowered.stack.arguments.len(), 1);
7057        assert_eq!(lowered.stack.arguments[0].1, 0);
7058        let text = mir::print_func(&lowered.func, &names, &REGS);
7059        assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
7060        assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
7061    }
7062
7063    #[test]
7064    fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
7065        let i64 = Type::int(64);
7066        let (mut names, mut source, block, args) = blank(&[i64; 8]);
7067        let mut build = Builder::new(&mut source, block);
7068        let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
7069        build.ret(&[sum]);
7070
7071        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7072            .expect("both are read from memory");
7073        let stack = lowered.stack;
7074        let mut out = lowered.func;
7075        let env = env();
7076        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7077        let layout = stack.layout(Layout::new(&SYSV, REGS));
7078        let frame = Frame::of(&out, &allocation, &layout);
7079        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7080
7081        // A leaf that takes no frame, so the stack pointer never moves and the only thing between
7082        // it and the caller's arguments is the return address the call pushed. The seventh
7083        // parameter is at the bottom of the caller's argument area and the eighth is one word
7084        // further up, which is the eight bytes between the two offsets.
7085        let text = mir::print_func(&out, &names, &REGS);
7086        assert_eq!(frame.size(), 0);
7087        assert_eq!(frame.incoming(), Incoming::from_stack(8));
7088        assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
7089        assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
7090    }
7091
7092    #[test]
7093    fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
7094        let i64 = Type::int(64);
7095        let (mut names, mut source, block, args) = blank(&[i64; 7]);
7096        let wide = slot(&mut source, block, 64, 32);
7097        let mut build = Builder::new(&mut source, block);
7098        build.store(args[6], wide, plain(), Flags::default());
7099        build.ret(&[args[6]]);
7100
7101        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7102            .expect("every instruction has a rule");
7103        let stack = lowered.stack;
7104        let mut out = lowered.func;
7105        let env = env();
7106        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7107        let layout = stack.layout(Layout::new(&SYSV, REGS));
7108        let frame = Frame::of(&out, &allocation, &layout);
7109        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7110
7111        // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
7112        // which throws away how far the caller's stack was. So the load the lowering wrote off the
7113        // stack pointer is rewritten to read through the frame pointer, at the one distance that
7114        // survives: the word the prologue pushed the frame pointer into, and the return address
7115        // above it.
7116        let text = mir::print_func(&out, &names, &REGS);
7117        assert_eq!(frame.realign(), Some(32));
7118        assert_eq!(frame.incoming(), Incoming::from_frame(16));
7119        assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
7120        assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
7121    }
7122
7123    #[test]
7124    fn a_jump_is_the_edge_and_nothing_else() {
7125        let i32 = Type::int(32);
7126        let (mut names, mut source, entry, args) = blank(&[i32]);
7127        let next = source.create_block();
7128        let got = source.append_param(next, i32);
7129        Builder::new(&mut source, entry).jump(next, &[args[0]]);
7130        Builder::new(&mut source, next).ret(&[got]);
7131
7132        // Two blocks and two instructions, and the jump is neither of them. What it was is the
7133        // arm on the first block, and what the arm carries is the argument it was called with.
7134        assert_eq!(
7135            lower(&mut names, &source),
7136            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
7137             block1(%1:gpr):\n    x64.ret_val_32 %1($rax)\n}\n"
7138        );
7139    }
7140
7141    /// A block that reads what a block below it writes is filled after it, not before it.
7142    ///
7143    /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
7144    /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
7145    /// Filling them in the order they are written reaches the read in `early` first, and reading
7146    /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
7147    /// what it does is give its answer the register its operand is already in, and that is not
7148    /// the register the read minted. Nothing writes the register the read minted. The printer
7149    /// says `%?` for a register nothing defines, which is what this looks for, and what came out
7150    /// of the real bug was SQLite loading a stack slot no store ever reached.
7151    #[test]
7152    fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
7153        let i64 = Type::int(64);
7154        let (mut names, mut source, entry, args) = blank(&[i64, i64]);
7155        let early = source.create_block();
7156        let late = source.create_block();
7157        let exit = source.create_block();
7158
7159        Builder::new(&mut source, entry).jump(late, &[]);
7160        let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
7161        Builder::new(&mut source, early).ret(&[ptr]);
7162        let mut build = Builder::new(&mut source, late);
7163        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7164        build.br_if(cond, early, &[], exit, &[]);
7165        Builder::new(&mut source, exit).ret(&[args[1]]);
7166
7167        let text = lower(&mut names, &source);
7168        assert!(!text.contains("%?"), "every register has something that writes it: {text}");
7169    }
7170
7171    /// A constant is written where it is wanted rather than where the IR defined it, and two
7172    /// blocks wanting the same one is two places. Writing it once and reading it in both is a
7173    /// register read where nothing wrote it, unless the block it was written in happens to
7174    /// dominate the other, which nothing here checks and which the second arm of a branch never
7175    /// does. Each block gets its own copy of the number instead.
7176    #[test]
7177    fn a_constant_two_blocks_want_is_written_in_both_of_them() {
7178        let i32 = Type::int(32);
7179        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7180        let then = source.create_block();
7181        let other = source.create_block();
7182        let join = source.create_block();
7183        let got = source.append_param(join, i32);
7184
7185        let mut build = Builder::new(&mut source, entry);
7186        let seven = build.iconst(i32, 7);
7187        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7188        build.br_if(cond, then, &[], other, &[]);
7189        // Both arms want the seven in a register, because a block argument is never an immediate,
7190        // and neither arm dominates the other.
7191        Builder::new(&mut source, then).jump(join, &[seven]);
7192        Builder::new(&mut source, other).jump(join, &[seven]);
7193        Builder::new(&mut source, join).ret(&[got]);
7194
7195        let text = lower(&mut names, &source);
7196        assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
7197    }
7198
7199    /// An argument on an edge out of a block that leaves two ways is read after every instruction
7200    /// of the block is written, and reading one can write an instruction, which would land after
7201    /// the branch that has already jumped past it. The branch goes back on the end.
7202    #[test]
7203    fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
7204        let i32 = Type::int(32);
7205        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7206        let then = source.create_block();
7207        let join = source.create_block();
7208        let got = source.append_param(join, i32);
7209
7210        let mut build = Builder::new(&mut source, entry);
7211        let nine = build.iconst(i32, 9);
7212        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7213        build.br_if(cond, then, &[], join, &[nine]);
7214        Builder::new(&mut source, then).jump(join, &[args[0]]);
7215        Builder::new(&mut source, join).ret(&[got]);
7216
7217        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7218            .expect("every instruction has a rule")
7219            .func;
7220        let entry = out.entry().expect("an entry block");
7221        let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
7222        let branch = names.intern("x64.br_cond_8");
7223        assert_eq!(
7224            out[last].opcode,
7225            mir::Opcode::new(branch),
7226            "the branch is last: {}",
7227            mir::print_func(&out, &names, &REGS)
7228        );
7229    }
7230
7231    #[test]
7232    fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
7233        let i32 = Type::int(32);
7234        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7235        let then = source.create_block();
7236        let other = source.create_block();
7237        let mut build = Builder::new(&mut source, entry);
7238        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7239        build.br_if(cond, then, &[], other, &[]);
7240        Builder::new(&mut source, then).ret(&[args[0]]);
7241        Builder::new(&mut source, other).ret(&[args[1]]);
7242
7243        // The comparison writes a byte and the branch reads it, and neither says a block. Both
7244        // arms are on the entry block, in the order the branch took them, so the arm that runs
7245        // when the condition holds is the first.
7246        assert_eq!(
7247            lower(&mut names, &source),
7248            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7249             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
7250             x64.br_cond_8 %2, block1, block2\n\n\
7251             block1:\n    x64.ret_val_32 %0($rax)\n\n\
7252             block2:\n    x64.ret_val_32 %1($rax)\n}\n"
7253        );
7254    }
7255
7256    /// A choice between two values, which is one instruction and no blocks at all.
7257    ///
7258    /// The arms come out the other way round from the IR, because a conditional move overwrites its
7259    /// destination and the destination is the arm taken when the condition does not hold. The
7260    /// condition arrives last for the same reason: it is read by the test in front of the move
7261    /// rather than by the move.
7262    #[test]
7263    fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
7264        let i32 = Type::int(32);
7265        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7266        let mut build = Builder::new(&mut source, entry);
7267        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7268        let picked = build.select(cond, args[0], args[1]);
7269        build.ret(&[picked]);
7270
7271        assert_eq!(
7272            lower(&mut names, &source),
7273            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
7274             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
7275             %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n    \
7276             x64.ret_val_32 %3($rax)\n}\n"
7277        );
7278    }
7279
7280    #[test]
7281    fn a_branch_over_a_block_is_a_whole_function_now() {
7282        let i32 = Type::int(32);
7283        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7284        let then = source.create_block();
7285        let other = source.create_block();
7286        let join = source.create_block();
7287        let got = source.append_param(join, i32);
7288        let mut build = Builder::new(&mut source, entry);
7289        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7290        build.br_if(cond, then, &[], other, &[]);
7291        let mut build = Builder::new(&mut source, then);
7292        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7293        build.jump(join, &[sum]);
7294        Builder::new(&mut source, other).jump(join, &[args[1]]);
7295        Builder::new(&mut source, join).ret(&[got]);
7296
7297        // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
7298        // the way a front end writes it: both arms of the branch are blocks of their own and the
7299        // return is the block they meet at. No edge here is critical, because the two arms out of
7300        // the entry carry nothing and the two arms into the join each leave a block that goes
7301        // nowhere else, so each has its own end to put its move at.
7302        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7303            .expect("every instruction has a rule")
7304            .func;
7305        assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
7306        let env = env();
7307        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7308        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7309        finish(
7310            &mut out,
7311            &allocation,
7312            &frame,
7313            &Stack::default(),
7314            Convention::new(&SYSV, &FRAME),
7315            &mut names,
7316        );
7317
7318        // One epilogue, on the join, which is the one block the function leaves from, and the
7319        // moves that give the join its parameter are at the end of each arm. Every register is
7320        // physical and the branch is still a branch on a register, because turning it into a
7321        // `test` and a `jcc` is the block layout's and there is no block layout yet.
7322        let text = mir::print_func(&out, &names, &REGS);
7323        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7324        assert!(text.contains("x64.br_cond_8"), "{text}");
7325        assert!(text.contains("x64.add_rr_32"), "{text}");
7326        assert!(!text.contains('%'), "{text}");
7327    }
7328
7329    #[test]
7330    fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
7331        let i32 = Type::int(32);
7332        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7333        let then = source.create_block();
7334        let join = source.create_block();
7335        let got = source.append_param(join, i32);
7336        let mut build = Builder::new(&mut source, entry);
7337        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7338        build.br_if(cond, then, &[], join, &[args[1]]);
7339        Builder::new(&mut source, then).jump(join, &[args[0]]);
7340        let mut build = Builder::new(&mut source, join);
7341        let twice = build.binary(Opcode::Add, got, got, Flags::default());
7342        build.ret(&[twice]);
7343
7344        // The else arm is critical: the entry block leaves two ways and the join is arrived at
7345        // two ways, and the arm carries a value. Without splitting it the allocator asserts,
7346        // because the move that gives the join its parameter would have to run at the end of a
7347        // block that also goes to the other arm.
7348        let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7349            .expect("every instruction has a rule")
7350            .func;
7351        assert_eq!(crate::split::critical(&mut out), 1);
7352        let env = env();
7353        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7354        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7355        finish(
7356            &mut out,
7357            &allocation,
7358            &frame,
7359            &Stack::default(),
7360            Convention::new(&SYSV, &FRAME),
7361            &mut names,
7362        );
7363
7364        // The block the split added is where the move went, and it is the whole of that block.
7365        let text = mir::print_func(&out, &names, &REGS);
7366        assert_eq!(out.block_count(), 4, "{text}");
7367        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7368    }
7369
7370    #[test]
7371    fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
7372        let i32 = Type::int(32);
7373        let (mut names, mut source, block, args) = blank(&[i32, i32]);
7374        let sig =
7375            source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
7376        let callee = names.intern("g");
7377        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
7378        let got = source[call].first_result.expect("an integer comes back");
7379        Builder::new(&mut source, block).ret(&[got]);
7380
7381        // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
7382        // them, so what the call reads is what arrived, and the whole of the convention is in the
7383        // constraints rather than in a move.
7384        let text = lower(&mut names, &source);
7385        assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
7386        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7387        // What the call writes is the value that comes back and then every register the callee is
7388        // free to destroy, in both classes, which is the whole of what stops the allocator from
7389        // leaving something in one of them.
7390        assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
7391        assert!(text.contains("$xmm15 = x64.call"), "{text}");
7392    }
7393
7394    #[test]
7395    fn what_the_frame_owes_a_call_comes_back_with_the_function() {
7396        let i32 = Type::int(32);
7397        let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
7398
7399        let (mut names, mut source, block, args) = blank(&[i32]);
7400        let sig = sig(&mut source);
7401        let callee = names.intern("g");
7402        Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7403        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7404            .expect("every instruction has a rule");
7405
7406        // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
7407        // owes the callee an aligned stack pointer and may not use the red zone.
7408        assert_eq!(out.stack.calls, Some(0));
7409        let layout = out.stack.layout(Layout::new(&SYSV, REGS));
7410        assert!(!layout.leaf);
7411        assert_eq!(layout.outgoing, 0);
7412
7413        // The same call under the other convention owes thirty two bytes for the callee to spill
7414        // its register arguments into, which is a fact about the convention and not about the call.
7415        let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7416            .expect("every instruction has a rule");
7417        assert_eq!(out.stack.calls, Some(32));
7418
7419        // And a function that calls nothing is a leaf, which is what says it may use the red zone.
7420        let (mut names, mut source, block, args) = blank(&[i32]);
7421        Builder::new(&mut source, block).ret(&[args[0]]);
7422        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7423            .expect("every instruction has a rule");
7424        assert_eq!(out.stack.calls, None);
7425        assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
7426    }
7427
7428    /// A Windows variadic prologue writes the argument registers the signature did not name into
7429    /// the shadow space the caller already reserved, which makes every argument one run of words up
7430    /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
7431    /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
7432    #[test]
7433    fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
7434        let mut names = Interner::new();
7435        let params = [Type::int(32), Type::PTR];
7436        let signature = Signature::new().with_params(&params).variadic();
7437        let mut source = Func::new(names.intern("f"), signature);
7438        let block = source.create_block();
7439        let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
7440        let mut build = Builder::new(&mut source, block);
7441        let args = build.func().push_values(&values[1..]);
7442        build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
7443        build.ret(&[]);
7444
7445        let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7446            .expect("every instruction has a rule");
7447        let text = mir::print_func(&out.func, &names, &REGS);
7448
7449        // Two named parameters, so the registers at the next two positions hold arguments nobody
7450        // named and both are written up into the caller's area. The displacement is empty here and
7451        // `finish` fills it in, the same way it does for a parameter the registers ran out before.
7452        assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
7453        assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
7454        assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
7455        assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
7456
7457        // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
7458        // sixteen bytes up, which is where the two arguments the signature does name stopped.
7459        assert_eq!(out.stack.arguments.len(), 3);
7460        assert_eq!(out.stack.arguments[2].1, 16);
7461    }
7462
7463    #[test]
7464    fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
7465        let i32 = Type::int(32);
7466        let (mut names, mut source, block, args) = blank(&[i32]);
7467        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7468        let callee = names.intern("g");
7469        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7470        let got = source[call].first_result.expect("an integer comes back");
7471        let mut build = Builder::new(&mut source, block);
7472        let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
7473        build.ret(&[sum]);
7474
7475        // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
7476        // question: `a` is read after the call and `rdi` is a register the call destroys.
7477        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7478            .expect("every instruction has a rule");
7479        let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
7480        let mut out = lowered.func;
7481        let env = env();
7482        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7483        let frame = Frame::of(&out, &allocation, &layout);
7484        finish(
7485            &mut out,
7486            &allocation,
7487            &frame,
7488            &Stack::default(),
7489            Convention::new(&SYSV, &FRAME),
7490            &mut names,
7491        );
7492
7493        // It went to a register the callee has to put back, and the prologue and epilogue are what
7494        // put it back, which is the whole bargain the two halves of a convention make.
7495        let text = mir::print_func(&out, &names, &REGS);
7496        assert!(text.contains("$rbx"), "{text}");
7497        assert!(!text.contains('%'), "{text}");
7498        assert_eq!(text.matches("x64.call").count(), 1, "{text}");
7499    }
7500
7501    #[test]
7502    fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
7503        let i64 = Type::int(64);
7504        let (mut names, mut source, block, args) = blank(&[i64]);
7505        let seven = vec![i64; 7];
7506        let sig = source.add_signature(Signature::new().with_params(&seven));
7507        let callee = names.intern("g");
7508        let passed = vec![args[0]; 7];
7509        Builder::new(&mut source, block).call(callee, sig, &passed);
7510
7511        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7512            .expect("the seventh goes to memory");
7513        // The bytes the call needs are on the layout the frame is worked out from, so that the
7514        // frame reserves as many as the widest call in the function asked for.
7515        assert_eq!(lowered.stack.calls, Some(8));
7516        let text = mir::print_func(&lowered.func, &names, &REGS);
7517        assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
7518    }
7519
7520    #[test]
7521    fn a_call_this_cannot_make_is_reported_rather_than_made() {
7522        let (mut names, mut source, block, _) = blank(&[]);
7523        let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
7524        let sig = source.add_signature(Signature::new().with_returns(&returns));
7525        let callee = names.intern("g");
7526        Builder::new(&mut source, block).call(callee, sig, &[]);
7527        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7528            .expect_err("a long double is on the x87");
7529        assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
7530    }
7531
7532    /// A `long double` on its own is a different answer, because on its own it comes back on the
7533    /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
7534    ///
7535    /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
7536    /// straight after it. That instruction has to be straight after it: the stack is one place and
7537    /// anything else that touched it before this ran would be looking at the value still on it.
7538    #[test]
7539    fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
7540        let (mut names, mut source, block, _) = blank(&[]);
7541        let long_double = Type::float(rucc_ir::Float::F80);
7542        let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
7543        let callee = names.intern("g");
7544        Builder::new(&mut source, block).call(callee, sig, &[]);
7545
7546        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7547            .expect("the value comes back in st0");
7548        let text = mir::print_func(&lowered.func, &names, &REGS);
7549        let after: Vec<&str> =
7550            text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
7551        assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
7552        assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
7553        // And the slot it went into is the sixteen bytes the type takes, like every other one.
7554        assert_eq!(lowered.stack.locals.len(), 1, "{text}");
7555        assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
7556    }
7557
7558    #[test]
7559    fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
7560        let i32 = Type::int(32);
7561        let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
7562        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7563        let varargs = source.push_abis(&[]);
7564        let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
7565        let mut build = Builder::new(&mut source, block);
7566        let inst = InstData {
7567            args: build.func().push_values(&[args[0], args[1]]),
7568            extra: Extra::Call(info),
7569            ..InstData::new(Opcode::CallIndirect)
7570        };
7571        let called = build.inst(inst, &[i32]);
7572        let got = source[called].first_result.expect("an integer comes back");
7573        Builder::new(&mut source, block).ret(&[got]);
7574
7575        // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
7576        // the arguments are the ones behind it, and everything else about the call is what a call
7577        // to a name would have been.
7578        let text = lower(&mut names, &source);
7579        assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
7580        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7581        assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
7582    }
7583
7584    #[test]
7585    fn an_instruction_no_rule_covers_is_reported() {
7586        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
7587        let mut build = Builder::new(&mut source, block);
7588        let operands = build.func().push_values(&[args[0]]);
7589        build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
7590
7591        // The mark that an object has come into being, which nothing writes an instruction for
7592        // yet: what it needs is a write over a range of the lifetime plane, and that is
7593        // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
7594        // message to add beyond the name.
7595        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7596            .expect_err("no rule writes the beginning of a lifetime");
7597        assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
7598
7599        // It produces nothing, so there is no type in the message and nothing invents one, and the
7600        // instruction comes back so a caller can ask the function where it was.
7601        let inst = failed.inst().expect("the instruction it is about");
7602        assert_eq!(source[inst].opcode, Opcode::MetaBegin);
7603    }
7604
7605    /// A barrier is written by name here, and what it is depends on the ordering and on nothing
7606    /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
7607    #[test]
7608    fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
7609        for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
7610            let (mut names, mut source, block, _) = blank(&[]);
7611            let mut build = Builder::new(&mut source, block);
7612            build
7613                .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
7614
7615            let text = lower(&mut names, &source);
7616            assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
7617        }
7618    }
7619
7620    /// A compare and exchange is written by name too, and at the width of the value rather than at
7621    /// the width of the address, which is the mistake worth pinning: everything here is a pointer
7622    /// and only the value says how many bytes the instruction touches.
7623    #[test]
7624    fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
7625        for bits in [8, 16, 32, 64] {
7626            let ty = Type::int(bits);
7627            let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
7628            let mut build = Builder::new(&mut source, block);
7629            let mem = build.func().add_mem(MemInfo {
7630                size: u64::from(bits / 8),
7631                align: bits / 8,
7632                order: MemOrder::SeqCst,
7633                ..plain()
7634            });
7635            let operands = build.func().push_values(&[args[0], args[1], args[2]]);
7636            build.inst(
7637                InstData {
7638                    args: operands,
7639                    extra: Extra::Mem(mem),
7640                    ..InstData::new(Opcode::Cmpxchg)
7641                },
7642                &[ty, Type::I1],
7643            );
7644
7645            // Two values out of one instruction, the first of them in the register the machine
7646            // reads the expected value out of, the second free for the allocator to place. The
7647            // address is the memory operand and neither of the two values is.
7648            let text = lower(&mut names, &source);
7649            let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
7650            assert!(text.contains(&written), "{bits}: {text}");
7651        }
7652    }
7653
7654    #[test]
7655    fn more_values_back_than_the_convention_has_registers_for_is_reported() {
7656        let i64 = Type::int(64);
7657        let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
7658        let mut build = Builder::new(&mut source, block);
7659        build.ret(&[args[0], args[1], args[2]]);
7660
7661        // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
7662        // gap in the rules but the convention saying no. The front end classifies before it gets
7663        // here, so this is the shape that would mean the classification went wrong.
7664        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7665            .expect_err("only two come back");
7666        assert_eq!(
7667            failed.to_string(),
7668            "what this function gives back takes more registers than this convention has for it"
7669        );
7670
7671        let inst = failed.inst().expect("the instruction it is about");
7672        assert_eq!(source[inst].opcode, Opcode::Return);
7673    }
7674
7675    /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
7676    ///
7677    /// Everything else is about something written somewhere in the body and hands it back so a
7678    /// caller can ask the function where it came from. A parameter arrives before the first
7679    /// instruction runs, so there is nothing in the body to point at and the message is about
7680    /// the function.
7681    #[test]
7682    fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
7683        let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
7684        assert_eq!(missing.inst(), None);
7685    }
7686
7687    /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
7688    fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
7689        let info = MemInfo { size, align, ..plain() };
7690        let mut build = Builder::new(source, block);
7691        let mem = build.func().add_mem(info);
7692        build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
7693    }
7694
7695    #[test]
7696    fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
7697        let (mut names, mut source, block, _) = blank(&[]);
7698        let slot = slot(&mut source, block, 4, 4);
7699        let mut build = Builder::new(&mut source, block);
7700        let nine = build.iconst(Type::int(32), 9);
7701        build.store(nine, slot, plain(), Flags::default());
7702        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
7703        build.ret(&[loaded]);
7704
7705        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7706            .expect("every instruction has a rule");
7707
7708        // Four bytes on the list the frame is laid out from, and the one instruction that reads
7709        // where they went. Its displacement is nothing here because there is no frame yet, and
7710        // which instruction is waiting for which local is what `finish` is handed.
7711        assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
7712        assert_eq!(lowered.stack.addresses.len(), 1);
7713        assert_eq!(lowered.stack.addresses[0].1, 0);
7714        assert_eq!(
7715            mir::print_func(&lowered.func, &names, &REGS),
7716            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [$rsp]\n    \
7717             %1:gpr = x64.mov_ri_32 9\n    x64.mov_mr_32 %1, [%0]\n    \
7718             %2:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %2($rax)\n}\n"
7719        );
7720    }
7721
7722    #[test]
7723    fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
7724        let (mut names, mut source, block, _) = blank(&[]);
7725        let scratch = slot(&mut source, block, 4, 4);
7726        let mut build = Builder::new(&mut source, block);
7727        let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
7728        let declared = build
7729            .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
7730        build.func().declare_mem(mem, 41);
7731        build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
7732        build.ret(&[]);
7733
7734        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7735            .expect("every instruction has a rule");
7736
7737        // Two locals and one declaration, held against the order the allocas were lowered in,
7738        // which is the only name a local has by the time the frame places it. The scratch one was
7739        // reached first and is local zero, so the declared one is local one.
7740        assert_eq!(lowered.stack.locals.len(), 2);
7741        assert_eq!(lowered.stack.declared, vec![(1, 41)]);
7742    }
7743
7744    /// A local the program kept in a value comes out saying which register holds it.
7745    ///
7746    /// The other half of the local above, which had a slot. This one has none, so what carries the
7747    /// declaration is the register the instruction computing it writes into.
7748    #[test]
7749    fn a_local_the_program_kept_in_a_value_says_which_register_holds_it() {
7750        let (mut names, mut source, block, _) = blank(&[]);
7751        let mut build = Builder::new(&mut source, block);
7752        let nine = build.iconst(Type::int(32), 9);
7753        let ten = build.iconst(Type::int(32), 10);
7754        let sum = build.binary(Opcode::Add, nine, ten, Flags::default());
7755        build.func().declare_value(sum, 41);
7756        build.ret(&[sum]);
7757
7758        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7759            .expect("every instruction has a rule");
7760
7761        // One pair and not three. The constants are values the program never declared, and a
7762        // register holding one of those is nobody's. The register is the one the addition writes,
7763        // which the listing under it is what pins down.
7764        assert_eq!(lowered.func.named, vec![(41, mir::Reg::virtual_reg(1))]);
7765        assert_eq!(
7766            mir::print_func(&lowered.func, &names, &REGS),
7767            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 9\n    \
7768             %1:gpr(reuse 1) = x64.add_ri_32 %0, 10\n    x64.ret_val_32 %1($rax)\n}\n"
7769        );
7770    }
7771
7772    /// A local held in a constant two blocks want is two registers and both of them are it.
7773    ///
7774    /// Why the declaration is written down as each register is handed out rather than once at the
7775    /// end over the map from values to registers. That map remembers the last register a value was
7776    /// written into, and a constant is written again in every block that wants one, so a local held
7777    /// in one would come out findable in the last block of the function and nowhere else.
7778    #[test]
7779    fn a_local_held_in_a_constant_two_blocks_want_is_named_in_both_of_them() {
7780        let i32 = Type::int(32);
7781        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7782        let then = source.create_block();
7783        let other = source.create_block();
7784        let join = source.create_block();
7785        let got = source.append_param(join, i32);
7786
7787        let mut build = Builder::new(&mut source, entry);
7788        let seven = build.iconst(i32, 7);
7789        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7790        build.func().declare_value(seven, 41);
7791        build.br_if(cond, then, &[], other, &[]);
7792        Builder::new(&mut source, then).jump(join, &[seven]);
7793        Builder::new(&mut source, other).jump(join, &[seven]);
7794        Builder::new(&mut source, join).ret(&[got]);
7795
7796        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7797            .expect("every instruction has a rule");
7798
7799        let held = &lowered.func.named;
7800        assert_eq!(held.len(), 2, "one register per block that wanted the seven: {held:?}");
7801        assert!(held.iter().all(|&(decl, _)| decl == 41), "{held:?}");
7802        assert_ne!(held[0].1, held[1].1, "the same register in two blocks: {held:?}");
7803    }
7804
7805    /// A parameter the program declared comes out named too, in the register it arrived in.
7806    ///
7807    /// The case the walk over the map at the end is for. A parameter is put in a register the
7808    /// convention chose rather than in a fresh one, so nothing asks the mint for it and the pair
7809    /// would otherwise never be written down.
7810    #[test]
7811    fn a_parameter_the_program_declared_says_which_register_it_arrived_in() {
7812        let i32 = Type::int(32);
7813        let (mut names, mut source, block, args) = blank(&[i32]);
7814        let mut build = Builder::new(&mut source, block);
7815        build.func().declare_value(args[0], 41);
7816        build.ret(&[args[0]]);
7817
7818        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7819            .expect("every instruction has a rule");
7820
7821        let held = &lowered.func.named;
7822        assert_eq!(held.len(), 1, "one pair for the one parameter: {held:?}");
7823        assert_eq!(held[0].0, 41);
7824    }
7825
7826    /// A function with nothing declared in it says nothing, which is every function compiled
7827    /// without debugging information asked for.
7828    #[test]
7829    fn a_function_the_front_end_named_nothing_in_names_no_registers() {
7830        let (mut names, mut source, block, _) = blank(&[]);
7831        let mut build = Builder::new(&mut source, block);
7832        let nine = build.iconst(Type::int(32), 9);
7833        build.ret(&[nine]);
7834
7835        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7836            .expect("every instruction has a rule");
7837        assert!(lowered.func.named.is_empty(), "{:?}", lowered.func.named);
7838    }
7839
7840    #[test]
7841    fn the_frame_is_what_fills_the_address_of_a_local_in() {
7842        let (mut names, mut source, block, _) = blank(&[]);
7843        let slot = slot(&mut source, block, 4, 4);
7844        let mut build = Builder::new(&mut source, block);
7845        let nine = build.iconst(Type::int(32), 9);
7846        build.store(nine, slot, plain(), Flags::default());
7847        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
7848        build.ret(&[loaded]);
7849
7850        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7851            .expect("every instruction has a rule");
7852        let stack = lowered.stack;
7853        let mut out = lowered.func;
7854        let env = env();
7855        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7856        let layout = stack.layout(Layout::new(&SYSV, REGS));
7857        let frame = Frame::of(&out, &allocation, &layout);
7858        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7859
7860        // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
7861        // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
7862        // never moves and the four bytes are below it, which is what the negative offset is. The
7863        // instruction the lowering left with nothing in its displacement now has the answer in it.
7864        let text = mir::print_func(&out, &names, &REGS);
7865        assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
7866        assert!(!text.contains("x64.sub_ri_64"), "{text}");
7867        assert_eq!(frame.size(), 0);
7868        assert_eq!(frame.local(0), Some(-8));
7869    }
7870
7871    /// An `alloca` whose size is an operand, which is a variable length array.
7872    fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
7873        let info = MemInfo { size: 0, align, ..plain() };
7874        let mut build = Builder::new(source, block);
7875        let mem = build.func().add_mem(info);
7876        let args = build.func().push_values(&[size]);
7877        build.value(
7878            InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
7879            Type::PTR,
7880        )
7881    }
7882
7883    #[test]
7884    fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
7885        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7886        let slot = growing(&mut source, block, args[0], 16);
7887        Builder::new(&mut source, block).ret(&[slot]);
7888
7889        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7890            .expect("every instruction has a rule");
7891
7892        // The bytes come off the stack pointer where the declaration stands and the address is
7893        // where the stack pointer then is, which is one subtraction and one `lea` rather than a
7894        // slot the frame laid out. Nothing is on the list of locals, because there is nothing
7895        // about this the frame could place.
7896        let text = mir::print_func(&lowered.func, &names, &REGS);
7897        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
7898        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
7899        assert!(lowered.stack.locals.is_empty(), "{text}");
7900        assert_eq!(lowered.stack.dynamic.len(), 1);
7901        assert!(lowered.stack.grown_at.is_some());
7902    }
7903
7904    #[test]
7905    fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
7906        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7907        let slot = growing(&mut source, block, args[0], 32);
7908        Builder::new(&mut source, block).ret(&[slot]);
7909
7910        // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
7911        // for means masking the stack pointer after moving it, and after that no constant reaches
7912        // the rest of the frame from the frame pointer either. A second pointer held for the
7913        // purpose is what fixes it and there is not one yet.
7914        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7915            .expect_err("nothing realigns a frame that grows");
7916        assert_eq!(
7917            failed.to_string(),
7918            "this local wants more alignment than the stack pointer is left on, which needs a \
7919             base register nothing here keeps"
7920        );
7921    }
7922
7923    #[test]
7924    fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
7925        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7926        let fixed = slot(&mut source, block, 4, 4);
7927        let mut build = Builder::new(&mut source, block);
7928        let nine = build.iconst(Type::int(32), 9);
7929        build.store(nine, fixed, plain(), Flags::default());
7930        let grown = growing(&mut source, block, args[0], 16);
7931        Builder::new(&mut source, block).ret(&[grown]);
7932
7933        let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7934            .expect("every instruction has a rule");
7935        let stack = lowered.stack;
7936        let mut out = lowered.func;
7937        let env = env();
7938        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7939        let layout = stack.layout(Layout::new(&SYSV, REGS));
7940        let frame = Frame::of(&out, &allocation, &layout);
7941        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7942
7943        // The stack pointer moves in the middle of the function, so the four bytes of the fixed
7944        // local are not a constant away from it any more and the frame pointer is what reaches
7945        // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
7946        // living in the red zone, and the address of the growing slot is off the stack pointer as
7947        // it stands after the subtraction rather than off anything the prologue left.
7948        let text = mir::print_func(&out, &names, &REGS);
7949        assert!(frame.grows());
7950        assert!(frame.frame_pointer());
7951        assert!(frame.size() > 0, "{text}");
7952        assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
7953        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
7954        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
7955    }
7956
7957    #[test]
7958    fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
7959        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
7960        let mut build = Builder::new(&mut source, block);
7961        let stepped = build.func().push_values(&[args[0], args[1]]);
7962        let next =
7963            build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
7964        let loaded = build.load(Type::int(32), next, plain(), Flags::default());
7965        build.ret(&[loaded]);
7966
7967        // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
7968        // in the rule set, which is the point: the two addresses arrive in registers because an
7969        // address is an integer as wide as one, and the arithmetic on them is the add it always
7970        // was, so every rule written about an add reaches it.
7971        //
7972        // The add stays its own instruction here rather than folding into the address the load
7973        // reads from. Two registers with no scale on either is the one addressing mode the rules
7974        // have no load through, because the folds that exist are the displacement one and the
7975        // scaled ones, and this is neither. `crate::fold` is what puts the two together, after
7976        // selection, and this is the pair it is handed.
7977        assert_eq!(
7978            lower(&mut names, &source),
7979            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
7980             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
7981             %3:gpr = x64.mov_rm_32 [%2]\n    x64.ret_val_32 %3($rax)\n}\n"
7982        );
7983    }
7984
7985    /// The address of a file scope name, which is what every use of a global and every string
7986    /// literal starts from.
7987    fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
7988        let symbol = names.intern(name);
7989        let mut build = Builder::new(source, block);
7990        build.value(
7991            InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
7992            Type::PTR,
7993        )
7994    }
7995
7996    #[test]
7997    fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
7998        let (mut names, mut source, block, _) = blank(&[]);
7999        let counter = address_of(&mut source, block, &mut names, "counter");
8000        let mut build = Builder::new(&mut source, block);
8001        let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
8002        build.ret(&[loaded]);
8003
8004        // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
8005        // that names no register and carries the symbol, which is what the assembler writes
8006        // relative to `%rip` and what the object writer leaves a relocation for.
8007        assert_eq!(
8008            lower(&mut names, &source),
8009            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [@counter]\n    \
8010             %1:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %1($rax)\n}\n"
8011        );
8012    }
8013
8014    #[test]
8015    fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
8016        let (mut names, mut source, block, _) = blank(&[]);
8017        let away = address_of(&mut source, block, &mut names, "away");
8018        Builder::new(&mut source, block).ret(&[away]);
8019        let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
8020
8021        // `extern void away(void); void *f(void) { return away; }`. A load and not an address
8022        // computation, because the distance from here to a name a shared library may be the one
8023        // that defines is not a number any link can work out, and the slot the linker fills in is
8024        // in this program and so is a distance it has.
8025        let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8026            .expect("every instruction has a rule");
8027        assert_eq!(
8028            mir::print_func(&out.func, &names, &REGS),
8029            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [got @away]\n    \
8030             x64.ret_val_64 %0($rax)\n}\n"
8031        );
8032    }
8033
8034    #[test]
8035    fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
8036        let (mut names, mut source, block, _) = blank(&[]);
8037        let own = address_of(&mut source, block, &mut names, "own");
8038        Builder::new(&mut source, block).ret(&[own]);
8039        let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
8040
8041        // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
8042        // the two cases above are one, because there is no address to load or to work out: the
8043        // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
8044        // thread's block starts, and the sum of the two is this thread's copy.
8045        let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
8046            .expect("every instruction has a rule");
8047        assert_eq!(
8048            mir::print_func(&out.func, &names, &REGS),
8049            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [thread @own]\n    \
8050             %1:gpr = x64.mov_rm_64 [fs:0]\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
8051             x64.ret_val_64 %2($rax)\n}\n"
8052        );
8053    }
8054
8055    /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
8056    #[test]
8057    fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
8058        let (mut names, mut source, block, _) = blank(&[]);
8059        let here =
8060            Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
8061        Builder::new(&mut source, block).ret(&[here]);
8062
8063        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8064            .expect("every instruction has a rule");
8065        assert_eq!(
8066            mir::print_func(&out.func, &names, &REGS),
8067            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
8068             x64.ret_val_64 %0($rax)\n}\n"
8069        );
8070    }
8071
8072    /// One `asm` statement, with its template and its constraint list written as a program does.
8073    fn assembly(
8074        source: &mut Func,
8075        block: Block,
8076        names: &mut Interner,
8077        template: &str,
8078        constraints: &str,
8079        args: &[Value],
8080        results: &[Type],
8081    ) -> Inst {
8082        clobbering(source, block, names, template, constraints, "memory", args, results)
8083    }
8084
8085    /// The same with a clobber list of its own, for the statements that are about one.
8086    #[allow(clippy::too_many_arguments)]
8087    fn clobbering(
8088        source: &mut Func,
8089        block: Block,
8090        names: &mut Interner,
8091        template: &str,
8092        constraints: &str,
8093        clobbers: &str,
8094        args: &[Value],
8095        results: &[Type],
8096    ) -> Inst {
8097        let info = AsmInfo {
8098            template: names.intern(template),
8099            constraints: names.intern(constraints),
8100            clobbers: names.intern(clobbers),
8101            targets: rucc_ir::BlockCallList::EMPTY,
8102        };
8103        Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
8104    }
8105
8106    /// What a program asking the processor what it can do writes, which is the instruction whose
8107    /// every operand is a register its text does not name.
8108    #[test]
8109    fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
8110        let u32 = Type::int(32);
8111        let (mut names, mut source, block, _) = blank(&[]);
8112        let zero = Builder::new(&mut source, block).iconst(u32, 0);
8113        let out = clobbering(
8114            &mut source,
8115            block,
8116            &mut names,
8117            "cpuid",
8118            "=a,a",
8119            "ebx,ecx,edx",
8120            &[zero],
8121            &[u32],
8122        );
8123        let produced = source[out].results().next().expect("one result");
8124        Builder::new(&mut source, block).ret(&[produced]);
8125
8126        // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
8127        // every program that has a faster path on some machines writes. Four registers written and
8128        // two read, none of them in the template, all of them out of the description, and the two
8129        // that the letters named are the statement's own. The subleaf is a zero because the
8130        // instruction reads `ecx` and the program said nothing about what is in it. The three
8131        // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
8132        // register with two definitions.
8133        assert_eq!(
8134            lower(&mut names, &source),
8135            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    \
8136             %1:gpr = x64.mov_ri_64 0\n    \
8137             %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
8138             %1($rcx)\n    x64.ret_val_32 %2($rax)\n}\n"
8139        );
8140    }
8141
8142    /// An operand the program pinned, by declaring the object it comes from `register long x asm
8143    /// ("r12")`. The letter on its own leaves the allocator to pick, and a template that reads the
8144    /// register by name needs the two to be the same register, so the brace is what ties them
8145    /// together. That is the one use of a local register variable the GNU manual calls reliable,
8146    /// and it is what tcc's `tests/tcctest.c` counts on.
8147    #[test]
8148    fn an_operand_the_program_pinned_is_placed_in_the_register_it_named() {
8149        let u64 = Type::int(64);
8150        let (mut names, mut source, block, _) = blank(&[]);
8151        let out =
8152            assembly(&mut source, block, &mut names, "mov $0x4542, %r12", "=r{r12}", &[], &[u64]);
8153        let produced = source[out].results().next().expect("one result");
8154        Builder::new(&mut source, block).ret(&[produced]);
8155
8156        // The template is one instruction the table already has, so it lowers to that instruction
8157        // rather than to text nobody read, and the register it names is the statement's own output
8158        // because the brace put the output there. Without the brace the letter would have let the
8159        // allocator pick, the two `%r12` would have been different registers, and the program would
8160        // have come back with whatever was in the one it picked.
8161        assert_eq!(
8162            lower(&mut names, &source),
8163            "mfunc @f {\nblock0:\n    %0:gpr($r12) = x64.mov_ri_64 17730\n    \
8164             x64.ret_val_64 %0($rax)\n}\n"
8165        );
8166    }
8167
8168    /// A clobber the instruction does not write itself, which is the case the list is there for.
8169    /// It goes on as a definition of the register, in among the other definitions, because that is
8170    /// the whole of how a machine function says a register is not worth anything after this.
8171    #[test]
8172    fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
8173        let (mut names, mut source, block, _) = blank(&[]);
8174        clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
8175        Builder::new(&mut source, block).ret(&[]);
8176
8177        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    $rsi = x64.pause\n}\n");
8178    }
8179
8180    /// A clobber naming something this has no register for. Refused rather than dropped, since the
8181    /// list is the program saying which registers it may not leave anything in, and an entry
8182    /// nobody read is a register something may still be left in.
8183    #[test]
8184    fn a_clobber_this_has_no_register_for_is_refused() {
8185        let (mut names, mut source, block, _) = blank(&[]);
8186        clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
8187        Builder::new(&mut source, block).ret(&[]);
8188
8189        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8190            .expect_err("there is no such register here");
8191        assert_eq!(
8192            failed.to_string(),
8193            "this `asm` says it destroys a register this has no name for"
8194        );
8195    }
8196
8197    #[test]
8198    fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
8199        let (mut names, mut source, block, _) = blank(&[]);
8200        assembly(&mut source, block, &mut names, "", "", &[], &[]);
8201        Builder::new(&mut source, block).ret(&[]);
8202
8203        // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
8204        // spent on the optimizer, which has finished by now, so what is left is nothing.
8205        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
8206    }
8207
8208    #[test]
8209    fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
8210        let i32 = Type::int(32);
8211        let (mut names, mut source, block, args) = blank(&[i32]);
8212        let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
8213        let produced = source[out].results().next().expect("one result");
8214        Builder::new(&mut source, block).ret(&[produced]);
8215
8216        // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
8217        // value without changing it. The two share a place and the template writes nothing over
8218        // it, so the value comes back out of the register it went in.
8219        assert_eq!(
8220            lower(&mut names, &source),
8221            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
8222             x64.ret_val_32 %0($rax)\n}\n"
8223        );
8224    }
8225
8226    #[test]
8227    fn an_output_written_plus_is_the_same_rename() {
8228        let i32 = Type::int(32);
8229        let (mut names, mut source, block, args) = blank(&[i32]);
8230        let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
8231        let produced = source[out].results().next().expect("one result");
8232        Builder::new(&mut source, block).ret(&[produced]);
8233
8234        // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
8235        assert_eq!(
8236            lower(&mut names, &source),
8237            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
8238             x64.ret_val_32 %0($rax)\n}\n"
8239        );
8240    }
8241
8242    #[test]
8243    fn an_output_nothing_is_tied_to_is_a_zero() {
8244        let i32 = Type::int(32);
8245        let (mut names, mut source, block, _) = blank(&[]);
8246        let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
8247        let produced = source[out].results().next().expect("one result");
8248        Builder::new(&mut source, block).ret(&[produced]);
8249
8250        // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
8251        // an empty template leaves nothing. A definite value rather than a register nothing wrote,
8252        // because the allocator is owed a definition before the use however little the program is.
8253        assert_eq!(
8254            lower(&mut names, &source),
8255            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
8256        );
8257    }
8258
8259    #[test]
8260    fn a_template_that_is_one_instruction_becomes_that_instruction() {
8261        let (mut names, mut source, block, _) = blank(&[]);
8262        assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
8263        Builder::new(&mut source, block).ret(&[]);
8264
8265        // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
8266        // instruction, no operands, and nothing between the template and the machine but the table
8267        // that already says what a `pause` is.
8268        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    x64.pause\n}\n");
8269    }
8270
8271    #[test]
8272    fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
8273        let i64 = Type::int(64);
8274        let (mut names, mut source, block, _) = blank(&[]);
8275        let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
8276        let produced = source[out].results().next().expect("one result");
8277        Builder::new(&mut source, block).ret(&[produced]);
8278
8279        // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
8280        // thread owns. The same instruction `crate::lower` already writes for a thread-local
8281        // variable, reached this time because a program wrote it out by hand.
8282        assert_eq!(
8283            lower(&mut names, &source),
8284            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
8285             x64.ret_val_64 %0($rax)\n}\n"
8286        );
8287    }
8288
8289    /// A template this cannot read is kept as its text, which is what gcc does with every template.
8290    /// Whether the text is an instruction is the assembler's question, asked when the unit is
8291    /// assembled from its listing.
8292    #[test]
8293    fn a_template_naming_an_instruction_this_machine_has_not_got_is_kept_as_text() {
8294        let (mut names, mut source, block, _) = blank(&[]);
8295        assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
8296        Builder::new(&mut source, block).ret(&[]);
8297
8298        let printed = lower(&mut names, &source);
8299        assert!(printed.contains("x64.template"), "{printed}");
8300        assert!(printed.contains("@hcf"), "{printed}");
8301    }
8302
8303    /// A template kept as text with an operand in a register reads the operand, and its text holds
8304    /// a hole naming that operand of the instruction, which the writer fills with the register the
8305    /// allocator chose. The input is the instruction's only use, behind every register a call may
8306    /// write.
8307    #[test]
8308    fn a_template_kept_as_text_reads_an_operand_in_a_register_through_a_hole() {
8309        let i32 = Type::int(32);
8310        let (mut names, mut source, block, args) = blank(&[i32]);
8311        assembly(&mut source, block, &mut names, "hcf %0", "r", &[args[0]], &[]);
8312        Builder::new(&mut source, block).ret(&[]);
8313
8314        let printed = lower(&mut names, &source);
8315        let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8316        // Twenty five registers are written ahead of it, so the operand read is the twenty sixth,
8317        // spelled at the width of an `int`.
8318        assert!(line.contains("x64.template %0, @hcf \u{1}r25k\u{2}"), "{printed}");
8319        assert!(line.contains("early $rax"), "{printed}");
8320    }
8321
8322    /// A template kept as text with more outputs than the convention keeps registers across a call
8323    /// gets back as many of the registers a call may write as it needs, from the end of the order,
8324    /// and keeps the rest. Six outputs against five preserved registers is one handed back, which is
8325    /// `r11`. The shape is `sodium_sub` in libsodium, whose `sbbq` into memory the reader has no
8326    /// form for, and before this the allocator ran out of registers on it.
8327    #[test]
8328    fn a_template_kept_as_text_with_more_outputs_than_are_kept_gets_registers_back() {
8329        let i64 = Type::int(64);
8330        let (mut names, mut source, block, _) = blank(&[]);
8331        let outputs = [i64; 6];
8332        let asm = assembly(
8333            &mut source,
8334            block,
8335            &mut names,
8336            "hcf %0, %1, %2, %3, %4, %5",
8337            "=&r,=&r,=&r,=&r,=&r,=&r",
8338            &[],
8339            &outputs,
8340        );
8341        let produced: Vec<Value> = source[asm].results().collect();
8342        Builder::new(&mut source, block).ret(&produced[..1]);
8343
8344        let printed = lower(&mut names, &source);
8345        let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8346        assert!(line.contains("early $r10"), "{printed}");
8347        assert!(!line.contains("early $r11"), "{printed}");
8348    }
8349
8350    /// A register the template named is placed as itself, fixed to the register the program wrote
8351    /// down. A register a constraint letter names is a different thing and is placed too, which the
8352    /// test above is about: there the statement said which of its own operands is in the register,
8353    /// and a name in the middle of a template says the register and nothing about any operand.
8354    #[test]
8355    fn a_template_naming_a_register_gets_that_register() {
8356        let i64 = Type::int(64);
8357        let (mut names, mut source, block, _) = blank(&[]);
8358        let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
8359        let produced = source[out].results().next().expect("one result");
8360        Builder::new(&mut source, block).ret(&[produced]);
8361
8362        // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
8363        // The source is the register itself and the destination is one the allocator picks.
8364        assert_eq!(
8365            lower(&mut names, &source),
8366            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rax($rax)\n    \
8367             x64.ret_val_64 %0($rax)\n}\n"
8368        );
8369    }
8370
8371    /// The half of the same thing every register saving template needs. micropython writes the
8372    /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
8373    /// of that line are a register the template named: the one being stored and the one the address
8374    /// is counted from.
8375    #[test]
8376    fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
8377        let (mut names, mut source, block, _) = blank(&[]);
8378        assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
8379        Builder::new(&mut source, block).ret(&[]);
8380
8381        assert_eq!(
8382            lower(&mut names, &source),
8383            "mfunc @f {\nblock0:\n    x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
8384        );
8385    }
8386
8387    /// A local kept in a named register, which is the same register named as itself and reached
8388    /// from the other side. micropython's collector writes six of these and reads them with
8389    /// ordinary C rather than with a template.
8390    #[test]
8391    fn a_local_kept_in_a_named_register_is_one_move_out_of_it() {
8392        let (mut names, mut source, block, _) = blank(&[]);
8393        let held = names.intern("rbx");
8394        let value = Builder::new(&mut source, block).value(
8395            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8396            Type::int(64),
8397        );
8398        Builder::new(&mut source, block).ret(&[value]);
8399
8400        assert_eq!(
8401            lower(&mut names, &source),
8402            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rbx($rbx)\n    \
8403             x64.ret_val_64 %0($rax)\n}\n"
8404        );
8405    }
8406
8407    /// The sigil gcc allows in front of the name is syntax and comes off, and a name that is not
8408    /// a register of this machine is refused in words that say which name it was.
8409    #[test]
8410    fn a_register_name_is_read_with_or_without_its_sigil_and_refused_when_there_is_no_such_one() {
8411        for written in ["%r12", "r12"] {
8412            let (mut names, mut source, block, _) = blank(&[]);
8413            let held = names.intern(written);
8414            let value = Builder::new(&mut source, block).value(
8415                InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8416                Type::int(64),
8417            );
8418            Builder::new(&mut source, block).ret(&[value]);
8419            assert!(lower(&mut names, &source).contains("$r12($r12)"), "{written} is not read");
8420        }
8421
8422        let (mut names, mut source, block, _) = blank(&[]);
8423        let held = names.intern("nowhere");
8424        let value = Builder::new(&mut source, block).value(
8425            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8426            Type::int(64),
8427        );
8428        Builder::new(&mut source, block).ret(&[value]);
8429
8430        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8431            .expect_err("there is no such register");
8432        assert_eq!(
8433            failed.to_string(),
8434            "this object is kept in `nowhere`, which is not a register this machine has"
8435        );
8436    }
8437
8438    #[test]
8439    fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
8440        let i32 = Type::int(32);
8441        let (mut names, mut source, block, args) = blank(&[i32]);
8442        assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
8443        Builder::new(&mut source, block).ret(&[]);
8444
8445        // An output with no result to be, which is what the front end never writes and what a
8446        // hand written module can. Refused rather than placed by a guess.
8447        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8448            .expect_err("the list and the instruction disagree");
8449        assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
8450    }
8451
8452    /// A cast between a pointer and an integer, at whatever width the result is asked for.
8453    fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
8454        let mut build = Builder::new(source, block);
8455        let args = build.func().push_values(&[from]);
8456        build.value(InstData { args, ..InstData::new(opcode) }, to)
8457    }
8458
8459    #[test]
8460    fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
8461        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8462        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
8463        Builder::new(&mut source, block).ret(&[number]);
8464
8465        // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
8466        // as the machine addresses, so the cast changes what the type system calls the value and
8467        // changes nothing about the value, and the register holding it is the one that held it.
8468        assert_eq!(
8469            lower(&mut names, &source),
8470            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
8471             x64.ret_val_64 %0($rax)\n}\n"
8472        );
8473    }
8474
8475    #[test]
8476    fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
8477        let (mut names, mut source, block, _) = blank(&[]);
8478        let mut build = Builder::new(&mut source, block);
8479        let zero = build.iconst(Type::int(64), 0);
8480        let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
8481        Builder::new(&mut source, block).ret(&[null]);
8482
8483        // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
8484        // writes the zero down: a constant is materialized where it is wanted rather than where
8485        // the IR defined it, and without the read there would be no instruction at all.
8486        assert_eq!(
8487            lower(&mut names, &source),
8488            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_64 0\n    x64.ret_val_64 %0($rax)\n}\n"
8489        );
8490    }
8491
8492    #[test]
8493    fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
8494        let readings = [
8495            (Linkage::External, mir::Binding::Global),
8496            (Linkage::Common, mir::Binding::Global),
8497            (Linkage::Internal, mir::Binding::Local),
8498            (Linkage::Weak, mir::Binding::Weak),
8499            (Linkage::LinkOnce, mir::Binding::Weak),
8500        ];
8501        for (linkage, wanted) in readings {
8502            let (mut names, mut source, block, _) = blank(&[]);
8503            source.linkage = linkage;
8504            Builder::new(&mut source, block).ret(&[]);
8505            let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8506                .expect("a return");
8507            // The narrowing is done here rather than where the object is written, because a
8508            // machine function is all the assembler and the writer are ever handed.
8509            assert_eq!(out.func.binding, wanted, "{linkage:?}");
8510        }
8511    }
8512
8513    /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
8514    /// three of them.
8515    ///
8516    /// Here for the reason the linkage above is here. A machine function is the whole of what the
8517    /// assembler and the object writer are handed, so a fact about the symbol that does not get
8518    /// onto one is a fact that is gone by the time anything could write it down, and the way that
8519    /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
8520    #[test]
8521    fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
8522        let readings = [
8523            (Visibility::Default, mir::Visibility::Default),
8524            (Visibility::Hidden, mir::Visibility::Hidden),
8525            (Visibility::Protected, mir::Visibility::Protected),
8526        ];
8527        for (visibility, wanted) in readings {
8528            let (mut names, mut source, block, _) = blank(&[]);
8529            source.visibility = visibility;
8530            Builder::new(&mut source, block).ret(&[]);
8531            let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8532                .expect("a return");
8533            assert_eq!(out.func.visibility, wanted, "{visibility:?}");
8534        }
8535    }
8536
8537    #[test]
8538    fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
8539        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8540        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
8541        Builder::new(&mut source, block).ret(&[number]);
8542
8543        // The front end never writes one: it casts at the address width and truncates or extends
8544        // around it, so both of those are the rules they always were. IR from somewhere else that
8545        // does write one is refused rather than compiled to a move that keeps the high half.
8546        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8547            .expect_err("no rule narrows an address");
8548        assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
8549    }
8550
8551    /// The type this machine has no register for.
8552    fn long_double() -> Type {
8553        Type::float(rucc_ir::Float::F80)
8554    }
8555
8556    #[test]
8557    fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
8558        let f64 = Type::float(rucc_ir::Float::F64);
8559        let (mut names, mut source, block, args) = blank(&[f64]);
8560        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8561        let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8562        Builder::new(&mut source, block).ret(&[back]);
8563
8564        // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
8565        // else, so the value is written to the crossing slot, loaded at the format that widens it
8566        // and put in the slot the eighty bit value lives in. Coming back is the same three the
8567        // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
8568        // every address in a frame looks like here until `finish` has the numbers.
8569        assert_eq!(
8570            lower(&mut names, &source),
8571            "mfunc @f {\nblock0:\n    \
8572             %0:xmm($xmm0) = x64.arg_val_f64\n    \
8573             %1:gpr = x64.lea_64 [$rsp]\n    \
8574             %2:gpr = x64.lea_64 [$rsp]\n    \
8575             x64.movsd_mr %0, [%1]\n    \
8576             x64.fld_l [%1]\n    \
8577             x64.fstp_t [%2]\n    \
8578             %3:gpr = x64.lea_64 [$rsp]\n    \
8579             %4:gpr = x64.lea_64 [$rsp]\n    \
8580             x64.fld_t [%3]\n    \
8581             x64.fstp_l [%4]\n    \
8582             %5:xmm = x64.movsd_rm [%4]\n    \
8583             x64.ret_val_f64 %5($xmm0)\n}\n"
8584        );
8585    }
8586
8587    #[test]
8588    fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
8589        let f64 = Type::float(rucc_ir::Float::F64);
8590        let (mut names, mut source, block, args) = blank(&[f64]);
8591        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8592        let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8593        let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8594        let mut build = Builder::new(&mut source, block);
8595        let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
8596        build.ret(&[sum]);
8597
8598        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8599            .expect("every instruction is written");
8600
8601        // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
8602        // psABI says one takes and is aligned to, and eight for the crossing, which every group
8603        // in the function shares because nothing is ever left in it. The value's slot is its own
8604        // for the whole function, so reading it twice reads the same sixteen bytes.
8605        assert_eq!(
8606            out.stack.locals,
8607            vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
8608        );
8609    }
8610
8611    #[test]
8612    fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
8613        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8614        let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
8615        let back =
8616            cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
8617        Builder::new(&mut source, block).ret(&[back]);
8618
8619        // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
8620        // format, so the conversion is the load and there is no instruction that converts.
8621        let text = lower(&mut names, &source);
8622        assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
8623        assert!(text.contains("x64.fild_ll [%1]"), "{text}");
8624    }
8625
8626    #[test]
8627    fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
8628        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
8629        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8630        let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
8631        Builder::new(&mut source, block).ret(&[whole]);
8632
8633        // The one conversion here with no single instruction behind it. C cuts towards zero and
8634        // the unit rounds the way its control word says, so the word is saved, ORed with the two
8635        // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
8636        // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
8637        let text = lower(&mut names, &source);
8638        let group: Vec<&str> = text
8639            .lines()
8640            .map(str::trim)
8641            .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
8642            .collect();
8643        assert_eq!(
8644            group,
8645            [
8646                "x64.fld_l [%1]",
8647                "x64.fstp_t [%2]",
8648                "x64.fnstcw [%5]",
8649                "%6:gpr = x64.mov_rm_16 [%5]",
8650                "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
8651                "x64.mov_mr_16 %7, [%5 + 2]",
8652                "x64.fldcw [%5 + 2]",
8653                "x64.fld_t [%3]",
8654                "x64.fistp_l [%4]",
8655                "x64.fldcw [%5]",
8656            ],
8657            "{text}"
8658        );
8659    }
8660
8661    #[test]
8662    fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
8663        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
8664        let mut build = Builder::new(&mut source, block);
8665        let value = build.load(long_double(), args[0], plain(), Flags::default());
8666        build.store(value, args[1], plain(), Flags::default());
8667        build.ret(&[]);
8668
8669        // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
8670        // format the value is already in, which neither converts nor looks: a signalling NaN stays
8671        // one and nothing is raised, which is the whole of what makes it a copy.
8672        let text = lower(&mut names, &source);
8673        let group: Vec<&str> =
8674            text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
8675        assert_eq!(
8676            group,
8677            ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
8678            "{text}"
8679        );
8680    }
8681
8682    /// Two `long double` values, from two `double` parameters, and the instructions that made
8683    /// them, which every test below this one throws away.
8684    fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
8685        let left = cast(source, block, Opcode::FPExt, args[0], long_double());
8686        let right = cast(source, block, Opcode::FPExt, args[1], long_double());
8687        (left, right)
8688    }
8689
8690    /// The x87 instructions of a function, in order, with everything else dropped.
8691    fn stack_only(text: &str) -> Vec<&str> {
8692        text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
8693    }
8694
8695    /// The two frame slots the last two addresses of a function were taken of, which in a
8696    /// comparison are the two operands in the order they go on the stack.
8697    fn pushed(out: &Lowered) -> Vec<usize> {
8698        let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
8699        taken[taken.len() - 2..].to_vec()
8700    }
8701
8702    #[test]
8703    fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
8704        let f64 = Type::float(rucc_ir::Float::F64);
8705        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8706        let (left, right) = two_long_doubles(&mut source, block, &args);
8707        let sum =
8708            Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
8709        let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
8710        Builder::new(&mut source, block).ret(&[back]);
8711
8712        // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
8713        // four lines are the add: both operands pushed, the instruction that names neither of
8714        // them because they are the top two of a stack, and the answer taken off into its slot.
8715        let text = lower(&mut names, &source);
8716        assert_eq!(
8717            stack_only(&text),
8718            [
8719                "x64.fld_l [%2]",
8720                "x64.fstp_t [%3]",
8721                "x64.fld_l [%4]",
8722                "x64.fstp_t [%5]",
8723                "x64.fld_t [%6]",
8724                "x64.fld_t [%7]",
8725                "x64.fadd_p",
8726                "x64.fstp_t [%8]",
8727                "x64.fld_t [%9]",
8728                "x64.fstp_l [%10]",
8729            ],
8730            "{text}"
8731        );
8732    }
8733
8734    #[test]
8735    fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
8736        let f64 = Type::float(rucc_ir::Float::F64);
8737        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8738        let (left, right) = two_long_doubles(&mut source, block, &args);
8739        let less =
8740            Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
8741        let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
8742        Builder::new(&mut source, block).ret(&[back]);
8743
8744        // The left one goes on first, so it ends up under the right one, and the answer wanted is
8745        // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
8746        // and computes the other one. The `r` says which spelling this is and not which order the
8747        // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
8748        // name is what got this wrong the first time.
8749        let text = lower(&mut names, &source);
8750        assert_eq!(
8751            &stack_only(&text)[4..8],
8752            ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
8753            "{text}"
8754        );
8755    }
8756
8757    #[test]
8758    fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
8759        let f64 = Type::float(rucc_ir::Float::F64);
8760        let (mut names, mut source, block, args) = blank(&[f64]);
8761        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8762        let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
8763        let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
8764        Builder::new(&mut source, block).ret(&[back]);
8765
8766        // `fchs` and not a subtraction from zero, which would give a different answer at a negative
8767        // zero and would signal at a NaN. It does not read the value as a number at all.
8768        let text = lower(&mut names, &source);
8769        assert_eq!(
8770            &stack_only(&text)[2..5],
8771            ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
8772            "{text}"
8773        );
8774    }
8775
8776    #[test]
8777    fn comparing_two_long_doubles_puts_the_left_one_on_top() {
8778        let f64 = Type::float(rucc_ir::Float::F64);
8779        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8780        let (left, right) = two_long_doubles(&mut source, block, &args);
8781        let mut build = Builder::new(&mut source, block);
8782        build.fcmp(FloatPred::Ogt, left, right, Flags::default());
8783        build.ret(&[]);
8784
8785        // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
8786        // operand the predicate is about has to go on last, which is the other way round from the
8787        // arithmetic above. The pop that clears the loser and the byte that reads the flags are
8788        // both inside the one opcode.
8789        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8790            .expect("every instruction is written");
8791        let slots = pushed(&out);
8792        assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
8793        let text = mir::print_func(&out.func, &names, &REGS);
8794        assert_eq!(
8795            &stack_only(&text)[4..],
8796            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
8797            "{text}"
8798        );
8799    }
8800
8801    #[test]
8802    fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
8803        let f64 = Type::float(rucc_ir::Float::F64);
8804        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8805        let (left, right) = two_long_doubles(&mut source, block, &args);
8806        let mut build = Builder::new(&mut source, block);
8807        build.fcmp(FloatPred::Olt, left, right, Flags::default());
8808        build.ret(&[]);
8809
8810        // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
8811        // the operands the other way round. The same trade the vector rules make, and it has to
8812        // be the same one: a `long double` comparison that picked a different condition from the
8813        // `double` comparison of the same two numbers would be wrong at exactly the unordered
8814        // cases the two conditions differ on.
8815        //
8816        // Which slot each push names is the whole of the difference from the test above, and the
8817        // text does not show it, since an address in a frame is a `lea` with nothing in it until
8818        // `finish` has the numbers. So the slots are what is read here.
8819        let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8820            .expect("every instruction is written");
8821        let slots = pushed(&out);
8822        assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
8823        let text = mir::print_func(&out.func, &names, &REGS);
8824        assert_eq!(
8825            &stack_only(&text)[4..],
8826            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
8827            "{text}"
8828        );
8829    }
8830
8831    #[test]
8832    fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
8833        let f64 = Type::float(rucc_ir::Float::F64);
8834        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8835        let (left, right) = two_long_doubles(&mut source, block, &args);
8836        let mut build = Builder::new(&mut source, block);
8837        build.fcmp(FloatPred::Oeq, left, right, Flags::default());
8838        build.ret(&[]);
8839
8840        // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
8841        // second register as well as the one the value is in and ANDs them together. Said here by
8842        // handing it a spare, since an instruction that wrote a register nothing knew about would
8843        // be an instruction the allocator could put a live value in the way of.
8844        let text = lower(&mut names, &source);
8845        assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
8846    }
8847
8848    #[test]
8849    fn a_comparison_that_is_never_asked_is_reported() {
8850        let f64 = Type::float(rucc_ir::Float::F64);
8851        let (mut names, mut source, block, args) = blank(&[f64, f64]);
8852        let (left, right) = two_long_doubles(&mut source, block, &args);
8853        let mut build = Builder::new(&mut source, block);
8854        build.fcmp(FloatPred::False, left, right, Flags::default());
8855        build.ret(&[]);
8856
8857        // Always false is a constant and not a comparison, so there is no condition to pick and
8858        // nothing here folds it into one: an instruction that quietly agreed with it would hide
8859        // that the optimizer left a comparison in that it should have taken out.
8860        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8861            .expect_err("no condition is always false");
8862        assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
8863    }
8864
8865    #[test]
8866    fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
8867        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8868        let mut build = Builder::new(&mut source, block);
8869        // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
8870        let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
8871        build.store(one_and_a_half, args[0], plain(), Flags::default());
8872        build.ret(&[]);
8873
8874        // No x87 instruction at all. A slot holding one of these is the value, so a constant is
8875        // its ten bytes written where the value lives, and whatever reads it does the `fld`.
8876        let text = lower(&mut names, &source);
8877        assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
8878        assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
8879        assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
8880        // The six bytes above the ten are the padding that makes the type sixteen wide, and they
8881        // are unspecified rather than zero, so nothing writes them.
8882        assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
8883    }
8884
8885    #[test]
8886    fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
8887        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8888        let mut build = Builder::new(&mut source, block);
8889        let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
8890        build.store(minus, args[0], plain(), Flags::default());
8891        build.ret(&[]);
8892
8893        // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
8894        // in a register with is above the signed range of sixteen bits and has to stay there: read
8895        // as a number it would be negative, and it is not a number, it is two bytes.
8896        let text = lower(&mut names, &source);
8897        assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
8898    }
8899
8900    #[test]
8901    fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
8902        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
8903        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8904        let next = source.create_block();
8905        let param = source.append_param(next, long_double());
8906        Builder::new(&mut source, block).jump(next, &[wide]);
8907        Builder::new(&mut source, next).ret(&[param]);
8908
8909        // What the edge carries is the address of the slot the value is already in, which is an
8910        // ordinary register the allocator has an opinion about. The block on the other side copies
8911        // the sixteen bytes into a slot of its own before anything reads them, so a second edge
8912        // handing over a second address would still leave one place for a reader to look.
8913        let text = lower(&mut names, &source);
8914        let second: Vec<&str> = text
8915            .lines()
8916            .skip_while(|line| !line.starts_with("block1"))
8917            .skip(1)
8918            .take(3)
8919            .map(str::trim)
8920            .collect();
8921        assert_eq!(
8922            second,
8923            ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
8924            "{text}"
8925        );
8926    }
8927
8928    #[test]
8929    fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
8930        let f64 = Type::float(rucc_ir::Float::F64);
8931        let (mut names, mut source, block, args) = blank(&[f64]);
8932        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8933        let next = source.create_block();
8934        let params: Vec<Value> =
8935            (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
8936        let carried: Vec<Value> = params.iter().map(|_| wide).collect();
8937        Builder::new(&mut source, block).jump(next, &carried);
8938        Builder::new(&mut source, next).ret(&[params[0]]);
8939
8940        // The copies go through the x87 stack so that every one of them is read before any of them
8941        // is written, which is what makes a block that swaps two of these right. Nine of them do
8942        // not fit on the stack, and copying the ninth before or after the rest is the order that
8943        // could be wrong, so it is refused instead.
8944        let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8945            .expect_err("nine do not fit on the stack");
8946        assert_eq!(
8947            failed.to_string(),
8948            "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
8949        );
8950        assert_eq!(failed.inst(), None);
8951    }
8952}