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::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::x86_64;
89use rucc_target::{CallRegs, Constraint, OperandDesc, PhysReg, RegClass, Role, Segment};
90
91use crate::abi::{self, Missing, Refused};
92use crate::coverage::Fired;
93use crate::elsewhere::Elsewhere;
94use crate::frame::{Layout, Local};
95use crate::select::{Match, Piece, Rule, Table};
96use crate::term::{MAX_ARGS, PLAIN, Plan, Shown, Term, Terms};
97use crate::varargs;
98
99/// The prefix a rule file puts in front of a machine term, which says which target it belongs
100/// to and is not part of the opcode.
101pub(crate) const PREFIX: &str = "x64.";
102
103/// The instruction a global offset table slot is read with.
104///
105/// Not in [`x86_64::FRAME`] with the other opcodes this file names, because a frame has no use for
106/// it. It is spelled out here because the relocation it takes is only legal on a `mov` with a REX
107/// prefix, so the width is part of the requirement rather than a choice.
108const GOT_LOAD: &str = "mov_rm_64";
109
110/// The instruction a template's `jmp` to a name outside it becomes.
111///
112/// Named here for [`GOT_LOAD`]'s reason turned round: a frame never writes one, because the only
113/// function it appears in has no prologue and no epilogue for the frame to write anything into.
114/// See [`x86_64::Step::Away`].
115const AWAY: &str = "jmp_away";
116
117/// How wide an address is on this target, which is the width a cast between a pointer and an
118/// integer has to be at for the cast to be nothing.
119const ADDRESS_BITS: u32 = 64;
120
121/// How much of a register an operand of an `asm` statement fills, which is the width of its type
122/// with two exceptions. A pointer is an address, and a truth value is the byte it is stored in: a
123/// program that writes `sete %0` into a `_Bool` is asking for exactly that byte, which is what tcc's
124/// own test of the width of one checks.
125fn held_bits(ty: Type) -> u32 {
126    if ty.is_ptr() {
127        ADDRESS_BITS
128    } else if ty.bits() == 1 {
129        8
130    } else {
131        ty.bits()
132    }
133}
134
135/// How many bytes a `long double` takes in memory, and what it is aligned to, which are the same
136/// number and are both more than the ten bytes that mean anything.
137///
138/// The psABI's answer rather than a choice here. `sizeof (long double)` is sixteen on this
139/// machine, so an array of them is laid out this way whatever a slot holding one does, and a slot
140/// that agreed with the array is one fewer thing to get wrong.
141const X87_BYTES: u32 = 16;
142
143/// How many values the x87 stack holds at once.
144///
145/// Eight, which is the machine's number rather than a choice here, and it matters in one place:
146/// the parameters of a block are copied through the stack so that they all move at once, and a
147/// block with more of them than this has nowhere to put the ninth.
148const X87_DEPTH: usize = 8;
149
150/// How far into the buffer of a `__builtin_setjmp` each of the four words it writes is.
151///
152/// The first three are gcc's, measured against gcc 16.2.0 on x86-64 at `-O0`: the frame pointer,
153/// the address control comes back to, and the stack pointer, in that order. The fourth is this
154/// compiler's own. gcc has no word for the answer because it writes a second block that sets the
155/// answer to one and is arrived at from the restore, and this writes the answer through memory
156/// instead, for the reason [`Lowering::saves_place`] gives.
157///
158/// None of the four is an interface. The buffer is the program's memory and its five words are
159/// the front end's promise about how much of it there is, but nothing except the matching restore
160/// ever reads a word of it, and a buffer written by one compiler was never going to be one another
161/// compiler could come back through.
162const JUMP_FRAME: i32 = 0;
163
164/// Where the address control comes back to is. See [`JUMP_FRAME`].
165const JUMP_PC: i32 = 8;
166
167/// Where the stack pointer is. See [`JUMP_FRAME`].
168const JUMP_STACK: i32 = 16;
169
170/// Where the address of the word the answer arrives in is. See [`JUMP_FRAME`].
171const JUMP_ANSWER: i32 = 24;
172
173/// How many bytes the word a `__builtin_setjmp` answers with takes in the frame, and what it is
174/// aligned to, which are the same number because it is one machine word.
175const JUMP_WORD: u32 = 8;
176
177/// How many registers the restore needs to hold things in while it puts the frame back.
178///
179/// Four, and every one of them is a register nothing else in the function may be in, which is why
180/// they are counted here rather than asked for one at a time. See [`Lowering::comes_back`].
181const JUMP_REGS: usize = 4;
182
183/// How many bytes a value passes through on its way between a register and the x87 stack.
184///
185/// Eight, because the widest thing that crosses is a `double` or a sixty four bit integer, and
186/// nothing crosses at eighty bits: a value that wide is already in the frame and the stack reaches
187/// it where it is.
188const X87_CROSSING: u32 = 8;
189
190/// Where the rounding field of the x87 control word is and what it has to be set to for the unit
191/// to cut towards zero, which is the one rounding C asks for that the unit does not do by default.
192///
193/// Both bits on is truncate. The field is ORed into the word that was already there rather than
194/// written over it, so the precision control and the exception masks somebody else set stay set.
195const X87_TRUNCATE: i64 = 0x0c00;
196
197/// Whether a type is the one this machine has no register for.
198///
199/// Only the eighty bit float is, and that is a fact about x86-64 rather than about floats: every
200/// other scalar the front end produces is in a general purpose register or a vector one, and this
201/// one is on the x87 stack while it is being worked on and in memory the rest of the time. So it
202/// has no place in [`Lowering::class_of`] and no name in [`crate::term`], and every instruction
203/// that touches one is written out by hand in this file.
204fn on_x87(ty: Type) -> bool {
205    ty.is_scalar() && ty.is_float() && ty.bits() == 80
206}
207
208/// Where one operand of an assembly statement is, on each side of the assembly.
209///
210/// Two registers rather than one, because an operand written `+` is a value that arrives and a
211/// value that leaves and those are two values. The machine IR has one definition per register by
212/// construction, so an instruction of the template that reads the operand and writes it has to name
213/// a different register in each place, and what makes the two one register in the end is the
214/// [`Constraint::Reuse`] the instruction's description carries: the allocator reads it, gives both
215/// the same physical register, and copies the incoming value somewhere first when something else is
216/// still using it.
217///
218/// Most operands have one of the two. An input has only a place it is read from and an output
219/// written `=` has only a place it is written to, and asking either of them for the other is an
220/// operand read where the opcode writes or written where it reads, which [`Lowering::placed`]
221/// refuses.
222#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
223struct Place {
224    /// The register the value arrives in, for an operand something reads.
225    read: Option<mir::Reg>,
226    /// The register the value leaves in, for an operand something writes.
227    write: Option<mir::Reg>,
228}
229
230/// Whether that operand of the statement is one the assembly may read, and so where a read of it
231/// gets its value from.
232///
233/// [`bound`] asks this question of an operand a constraint letter named and this asks it of one the
234/// template numbered, which is the same question twice because a two-address instruction reaches
235/// its first source both ways. `mulq %3` reaches `rax` by the letter on the output and libgmp says
236/// what is in it with `"%0"` on an input. `addq %5,%q1` reaches its first source by numbering the
237/// output, and libgmp says what is in it with `"0"` on an input in the same way.
238///
239/// So an output written `=` has no value of its own and is still readable when an input is tied to
240/// it, and the value the read wants is that input's. An output written `+` carries its own value
241/// and answers with that. An output nothing is tied to answers `None`, which is a program that told
242/// the compiler the assembly only writes the operand while the instruction reads it before it
243/// writes it, and is refused where it is asked.
244fn read_as(list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
245    let operand = list.get(index)?;
246    if operand.value.is_some() {
247        return operand.value;
248    }
249    operand.result?;
250    list.iter().find(|entry| entry.tied == Some(index)).and_then(|entry| entry.value)
251}
252
253/// Which of an assembly statement's operands is in that register, for an instruction that reaches
254/// the register without its text saying so.
255///
256/// The constraint is what says so, and it is the only thing in such a statement that could:
257/// `"=a"` is an output in `rax`, `"c"` is an input in `rcx`, an operand that is a local register
258/// variable is in the register its declaration named, and a register nothing names is a register
259/// nobody has said anything about. So a write looks among the outputs and a read among the inputs,
260/// and an output written `+` answers for either, since it is read before it is written. See
261/// [`pinned`], which is the one question asked of both ways of saying it.
262///
263/// The other way a read of such a register is said is a matching constraint. `"=a"` on an output
264/// and `"0"` on an input is the program saying that one register holds the input on the way in and
265/// the output on the way out, and it is how a statement fills a register the instruction reads and
266/// writes without writing the register down twice. The letter is on the output, which has no value
267/// to read, and the value is on the input, which has no letter, and the answer is the output: its
268/// place is read out of the register the input arrived in, and in a template with a loop in it the
269/// place moves on to wherever the last write left it, which is what a read on the next time round
270/// wants. tcc steps a pointer along a string with `lodsb` and `"=&S"` tied to `"0"`, and a read of
271/// the input would start the string again every time round.
272///
273/// And a read of a register an output alone is in is a read of that output, the same as a read of
274/// an output the template numbered. tcc copies a string with `lodsb` and `stosb` and `"=&a"` on an
275/// output nothing is tied to, and what `stosb` stores is what `lodsb` loaded one line up, which is
276/// the output as the template left it rather than anything the statement handed in.
277///
278/// `None` is a register the instruction uses and the statement put nothing in, which is the usual
279/// answer rather than an unusual one. `cpuid` writes four registers and a program that wanted one
280/// of them names one. See [`Lowering::spare`], which is where that one goes.
281fn bound(list: &[AsmOperand<'_>], reg: PhysReg, role: Role) -> Option<usize> {
282    let output =
283        list.iter().position(|operand| operand.result.is_some() && pinned(operand) == Some(reg));
284    if role.is_def() {
285        return output;
286    }
287    // The output first when something is in it on the way in, which is what `+` and a matching
288    // constraint both say, since its place is where a write earlier in the template left it and
289    // the read wants that. See [`read_as`] for what it holds before anything wrote it.
290    let arrives = |at: usize| read_as(list, at).is_some();
291    if let Some(at) = output.filter(|&at| arrives(at)) {
292        return Some(at);
293    }
294    let named = list.iter().position(|operand| {
295        operand.result.is_none() && operand.value.is_some() && pinned(operand) == Some(reg)
296    });
297    named.or(output)
298}
299
300/// The register one of an assembly statement's operands is in, whichever of the two ways said it.
301///
302/// A constraint letter is one way and is the only way a program can say one of the six registers
303/// that have a letter. A local register variable is the other, and it is the only way to say any
304/// of the rest: there is no letter for `r12`, which is the whole reason the extension exists, so
305/// the declaration says it and the front end wrote the name into the constraint. The name is read
306/// against this machine's table here, the same place the letter is read against it, and a name the
307/// machine has not got answers nothing, which leaves the operand where an operand nobody placed
308/// goes.
309///
310/// The sigil gcc allows in front of a name is taken off here, because what a name is written with
311/// is syntax and which register it means is this question.
312fn pinned(operand: &AsmOperand<'_>) -> Option<PhysReg> {
313    match operand.named {
314        Some(name) => {
315            let (reg, _) = x86_64::gpr_named(name.strip_prefix('%').unwrap_or(name))?;
316            Some(reg)
317        }
318        None => operand.fixed.and_then(x86_64::gpr_letter),
319    }
320}
321
322/// Why a function could not be lowered.
323///
324/// One reason and then nothing. A function with no rule for something in it is a function this
325/// cannot finish, and the second thing it could not lower is not news.
326#[derive(Debug, Clone, PartialEq, Eq)]
327pub enum Unsupported {
328    /// An instruction no rule fires on.
329    Inst {
330        /// The instruction that stopped it.
331        inst: Inst,
332        /// What the rule file would call it, or nothing if the rule language has no name for it
333        /// at all, which is what an instruction at a width nothing is written about looks like.
334        term: Option<&'static str>,
335        /// The opcode, which is what gets named when the rule language has no word for it.
336        ///
337        /// An opcode the rule language has no word for is exactly the opcode no rule lowers, so
338        /// without this the message would be empty in every case where somebody needs it.
339        opcode: Opcode,
340        /// What it produces, or nothing for an instruction that is only an effect.
341        ty: Option<Type>,
342    },
343    /// A parameter that does not arrive somewhere this can bring it in from.
344    ///
345    /// Not an instruction, which is why it is a separate arm: it is a fact about the signature
346    /// and there is nothing in the body of the function to point at.
347    Argument {
348        /// Its position in the signature.
349        index: usize,
350        /// What is wrong with where it arrives.
351        missing: Missing,
352    },
353    /// A call that passes or gives back a value this cannot put where the convention wants it.
354    Call {
355        /// The call.
356        inst: Inst,
357        /// Which value, and what is wrong with where it travels.
358        refused: Refused,
359    },
360    /// A `return` this cannot put where the convention wants it.
361    ///
362    /// A separate arm from [`Unsupported::Inst`] because it is not an instruction no rule fires
363    /// on. A return of more than one value is built from the convention rather than matched, the
364    /// same way a call is, so what goes wrong with one is what goes wrong with a call and not the
365    /// absence of a rule.
366    Returned {
367        /// The `return`.
368        inst: Inst,
369        /// What is wrong with where one of the values travels.
370        missing: Missing,
371    },
372    /// A stack slot the frame cannot give the bytes it asked for.
373    ///
374    /// Not an instruction no rule covers. An `alloca` is built here rather than matched, so what
375    /// goes wrong with one is what the frame can and cannot hold rather than what the rules spell.
376    Dynamic {
377        /// The `alloca`.
378        inst: Inst,
379        /// What the frame could not do about it.
380        growing: Growing,
381    },
382    /// More parameters of a type that travels on the x87 stack than the stack is deep.
383    ///
384    /// Not an instruction either, for the reason a function's parameter is not one: it is a fact
385    /// about the block and there is nothing in the block to point at. What crosses an edge for one
386    /// of these is the address of where the value is, and the block copies the bytes into a slot
387    /// of its own, all of them through the stack at once so that a block carrying two of them
388    /// swapped is copied in an order that is right. Eight is as many as the stack holds, and a
389    /// ninth would have to be copied before or after the rest, which is the order that could be
390    /// wrong.
391    Phi {
392        /// Which block it arrives at.
393        block: Block,
394        /// How many of them arrive there, which is the whole of what is wrong.
395        count: usize,
396        /// What they are.
397        ty: Type,
398    },
399    /// An `asm` statement this cannot build.
400    ///
401    /// Not an instruction no rule fires on, for the reason a call is not one: what it stands for is
402    /// whatever its template says, and no pattern over terms can read a string.
403    Assembly {
404        /// The `inline_asm`.
405        inst: Inst,
406        /// What about it is not built here yet.
407        refused: Written,
408    },
409    /// A `register long x asm ("...")` naming something this machine has not got.
410    ///
411    /// Not an instruction no rule fires on. There is a rule's worth of instruction here and what
412    /// is wrong is the string beside it, which is a name rather than a term, so the message says
413    /// the name. Which names a machine has is the machine's own question and this is where it is
414    /// asked, at the table a clobber list is read against.
415    Register {
416        /// The `register_value`.
417        inst: Inst,
418        /// The name the program wrote, as it wrote it.
419        name: String,
420    },
421    /// A naked function whose frame is not empty.
422    ///
423    /// Not an instruction no rule fires on, and there is nothing in the body to point at: the
424    /// function asked for no prologue and then wanted bytes only a prologue takes. Refused rather
425    /// than given the bytes anyway, because an offset into a frame nothing set up reaches into
426    /// whatever the caller left below its own stack pointer, which is wrong code that assembles.
427    /// See [`crate::frame::Layout::naked`].
428    Naked {
429        /// How many bytes it wanted, which is the whole of what is wrong.
430        bytes: u32,
431    },
432}
433
434/// What about an `asm` statement is not built yet.
435#[derive(Debug, Clone, Copy, PartialEq, Eq)]
436pub enum Written {
437    /// A template with instructions in it.
438    Template,
439    /// An `asm goto`, whose labels make the statement a terminator.
440    Goto,
441    /// An operand this cannot put where the constraint says it goes.
442    Operand,
443    /// A clobber list naming something this has no register for.
444    Clobber,
445    /// A `jmp` out of the function in a function that has an epilogue behind it.
446    Away,
447}
448
449impl Written {
450    /// The rest of the sentence that starts with the statement.
451    #[must_use]
452    pub fn why(self) -> &'static str {
453        match self {
454            // The template is the assembler's to read and there is no assembler here yet, so a
455            // template with anything in it is a string nothing can turn into bytes. An empty one is
456            // no instructions, and no instructions is something this can write.
457            Written::Template => "has instructions in its template, which nothing here assembles",
458            Written::Goto => "jumps to a label, which nothing here builds an edge for",
459            Written::Operand => "has an operand this cannot place",
460            Written::Clobber => "says it destroys a register this has no name for",
461            Written::Away => {
462                "jumps out of the function, which only a function that is `naked` may do, since \
463                 anywhere else there is an epilogue behind it to give the frame back"
464            }
465        }
466    }
467}
468
469/// What the frame could not do about a stack slot.
470#[derive(Debug, Clone, Copy, PartialEq, Eq)]
471pub enum Growing {
472    /// An object of a size the number a frame counts bytes in does not reach.
473    Huge,
474    /// A variable length array wanting more alignment than a call leaves the stack pointer with.
475    ///
476    /// Rounding the stack pointer down again after the bytes have been taken would put it
477    /// somewhere no constant reaches the rest of the frame from, so a frame like this needs a
478    /// second base register held for the whole of the function. Nothing here holds one.
479    ///
480    /// [`crate::expand::rounds`] takes the array away before this sees it, by asking for the
481    /// alignment in extra bytes and handing out an address inside them, so what is left of this
482    /// is IR that arrived without going through that pass and the fixed local in
483    /// [`crate::pipeline`] that wants the same thing from the other side.
484    Aligned,
485    /// A variable length array in a function written without a prologue.
486    ///
487    /// A frame that grows is reached from a frame pointer, and establishing one is the first two
488    /// instructions of a prologue that `__attribute__((naked))` asked there be none of. See
489    /// [`crate::frame::Layout::naked`].
490    Naked,
491}
492
493impl Growing {
494    /// The rest of the sentence that starts with the slot.
495    #[must_use]
496    pub fn why(self) -> &'static str {
497        match self {
498            Growing::Huge => "is more bytes than a frame counts",
499            Growing::Aligned => {
500                "wants more alignment than the stack pointer is left on, which needs a base \
501                 register nothing here keeps"
502            }
503            Growing::Naked => {
504                "is in a function that is `naked`, which has no prologue to point a frame pointer \
505                 at it with"
506            }
507        }
508    }
509}
510
511impl Unsupported {
512    /// The instruction it is about, or nothing for the one arm that is about a signature.
513    ///
514    /// What a caller wants this for is the span. The function knows where every instruction in
515    /// it came from, so a caller holding both can point a message at the line somebody wrote
516    /// rather than at the file as a whole, and nothing here has to carry a span of its own.
517    pub fn inst(&self) -> Option<Inst> {
518        match *self {
519            Unsupported::Inst { inst, .. }
520            | Unsupported::Call { inst, .. }
521            | Unsupported::Returned { inst, .. }
522            | Unsupported::Dynamic { inst, .. }
523            | Unsupported::Assembly { inst, .. }
524            | Unsupported::Register { inst, .. } => Some(inst),
525            Unsupported::Argument { .. } | Unsupported::Phi { .. } | Unsupported::Naked { .. } => {
526                None
527            }
528        }
529    }
530}
531
532impl fmt::Display for Unsupported {
533    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
534        match *self {
535            Unsupported::Inst { term: Some(term), .. } => write!(f, "no rule lowers `{term}`"),
536            Unsupported::Inst { term: None, opcode, ty: Some(ty), .. } => {
537                write!(f, "no rule lowers a `{opcode}` producing a `{ty}`")
538            }
539            Unsupported::Inst { term: None, opcode, ty: None, .. } => {
540                write!(f, "no rule lowers a `{opcode}`")
541            }
542            Unsupported::Argument { index, missing } => {
543                write!(f, "parameter {index} {}", missing.why())
544            }
545            Unsupported::Call { refused: Refused { argument: Some(index), missing }, .. } => {
546                write!(f, "argument {index} of this call {}", missing.why())
547            }
548            Unsupported::Call { refused: Refused { argument: None, missing }, .. } => {
549                write!(f, "what this call gives back {}", missing.why())
550            }
551            Unsupported::Returned { missing, .. } => {
552                write!(f, "what this function gives back {}", missing.why())
553            }
554            Unsupported::Dynamic { growing, .. } => {
555                write!(f, "this local {}", growing.why())
556            }
557            Unsupported::Phi { block, count, ty } => {
558                let block = block.index();
559                write!(
560                    f,
561                    "block{block} takes {count} parameters of type `{ty}` and only {X87_DEPTH} can cross an edge at once"
562                )
563            }
564            Unsupported::Assembly { refused, .. } => write!(f, "this `asm` {}", refused.why()),
565            Unsupported::Register { ref name, .. } => {
566                write!(
567                    f,
568                    "this object is kept in `{name}`, which is not a register this machine has"
569                )
570            }
571            Unsupported::Naked { bytes } => write!(
572                f,
573                "this function is `naked` and wants {bytes} bytes of frame, which there is no prologue to take"
574            ),
575        }
576    }
577}
578
579impl std::error::Error for Unsupported {}
580
581/// A lowered function, and what the frame needs that the machine IR does not hold.
582#[derive(Debug)]
583pub struct Lowered {
584    /// The function, in machine instructions.
585    pub func: mir::Func,
586    /// What it wants its stack to look like, which is separate from the function so that the two
587    /// can be read and written at the same time.
588    pub stack: Stack,
589    /// Which rules of the table lowered it, which is what `-Zrule-coverage` asks for and what
590    /// `crate::coverage` writes down.
591    pub fired: Fired,
592    /// Which machine IR block each IR block became, indexed by the IR block's own index, and
593    /// nothing for a block the walk never reached.
594    ///
595    /// Here because it is the only place the correspondence exists. Selection makes one block per
596    /// block, in the same order and with the arms in the same order, so anything the IR knows
597    /// about a block can be carried down through this and nothing else, and
598    /// [`crate::weights::carry`] is what does.
599    pub blocks: Vec<Option<mir::Block>>,
600}
601
602/// What a function's stack has to hold, as far as selection is able to say.
603///
604/// All of it is answered here because selection is where a call is built and where an `alloca`
605/// is read, and nothing after it could tell what either of them needed.
606#[derive(Debug, Default)]
607pub struct Stack {
608    /// How many bytes the widest call in the function needs below the stack pointer for the
609    /// arguments it passes there, or `None` for a function that makes no call at all.
610    ///
611    /// `None` is a leaf, which is the function that may use the red zone and the one whose stack
612    /// pointer does not have to be left aligned for anybody.
613    pub calls: Option<u32>,
614    /// The memory the function asked for itself, one entry for every `alloca` in it, in the order
615    /// the walk reached them.
616    pub locals: Vec<Local>,
617    /// Which instruction computes the address of which of those locals.
618    ///
619    /// An address in the frame is a distance from the stack pointer, and there is no frame until
620    /// after allocation, so the instruction is written here with nothing in its displacement and
621    /// [`crate::finish`] writes the number in once [`crate::frame::Frame`] knows it.
622    pub addresses: Vec<(mir::Inst, usize)>,
623    /// Which of those locals is which declaration in the source, for the ones the program declared.
624    ///
625    /// The number is the one the IR function carries and means nothing here. What it is for is the
626    /// debugging information, which has to say where a named local ended up and cannot ask the
627    /// frame directly: the frame knows a local by the order the `alloca` for it was lowered in and
628    /// by nothing else.
629    ///
630    /// Shorter than the list above rather than the same length, because most of what a function
631    /// keeps in its frame is memory an expression wanted somewhere to put.
632    pub declared: Vec<(usize, u32)>,
633    /// Which instruction computes the address of a piece of memory whose size the function works
634    /// out while it runs, which is what a variable length array is.
635    ///
636    /// Waiting on [`crate::finish`] for a different number from the one the addresses above are:
637    /// the bytes were taken off the stack pointer by the instruction in front of this one, so where
638    /// they start is however much of the bottom of the frame belongs to the arguments of a call,
639    /// and that is not known until the frame is.
640    pub dynamic: Vec<mir::Inst>,
641    /// Which instruction takes those bytes off the stack pointer, one for every one of them, in the
642    /// order the walk reached them.
643    ///
644    /// Read by [`crate::finish`] on a command line that asked for the stack to be touched a page at
645    /// a time, which is the one thing that has to find these again: the bytes are in a register by
646    /// then, so the walk down to them is a loop, and a loop is written around an instruction rather
647    /// than in front of a block. Nothing else looks at them, because everything else about a frame
648    /// that grows is answered by the address the instruction below this one computes.
649    pub grown: Vec<mir::Inst>,
650    /// Where the function first moves the stack pointer while it runs, if it does at all.
651    ///
652    /// Two things are read off this. One is whether at all, which is what [`crate::frame::Layout`]
653    /// wants, because a frame that moves its stack pointer has a different shape from one that does
654    /// not and the layout is built before the instructions are looked at again. See `Growing` in
655    /// [`crate::frame`]. The other is where, so that a caller that cannot accept such a frame has
656    /// somewhere to point when it says so.
657    pub grown_at: Option<Inst>,
658    /// Which instruction reads which of the arguments the caller passed on the stack, as how far up
659    /// the caller's argument area it reads.
660    ///
661    /// Waiting on [`crate::finish`] for the same reason the addresses above are, and on one thing
662    /// more: where the caller's argument area is from inside this function depends on whether the
663    /// prologue had to force the stack pointer's alignment, so which register the load reads
664    /// through is not settled here either.
665    pub arguments: Vec<(mir::Inst, u32)>,
666    /// Whether the function asked where its own frame is, which is what `__builtin_frame_address`
667    /// and `__builtin_return_address` both start from.
668    ///
669    /// A function like that keeps a frame pointer whatever the flags say, because the register is
670    /// the answer to the first of them and the start of the walk for every depth above zero. There
671    /// is no other way to reach it: the distance from the stack pointer to the frame is a number
672    /// the layout works out, and what a walk up the chain needs is the link the prologue saved.
673    pub walks_frames: bool,
674    /// Whether the function saved a place for a `__builtin_longjmp` to come back to, which is what
675    /// `__builtin_setjmp` does.
676    ///
677    /// A function like that keeps a frame pointer whatever the flags say as well, and for a reason
678    /// of the same shape: the two registers the restore puts back are the frame pointer and the
679    /// stack pointer, and a frame that did not keep the first of them has nothing in it saying
680    /// where the caller's frame is for the epilogue to find after control has come back.
681    pub saves_place: bool,
682}
683
684impl Stack {
685    /// The layout given, with the three fields only the lowering knows the answer to filled in.
686    ///
687    /// Everything else in a layout comes from the flags the function is compiled under or from the
688    /// allocation, so this takes one and returns it rather than building one.
689    ///
690    /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
691    /// zone, which is the words below the stack pointer nothing else may write, and a function
692    /// control comes back into from a `__builtin_longjmp` has already had something else running
693    /// down there: whatever it called and whatever that called, or a signal handler on the same
694    /// stack. Every one of those has written over the red zone by the time control arrives, so a
695    /// value this function left there would not be there any more.
696    #[must_use]
697    pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
698        Layout {
699            leaf: self.calls.is_none() && !self.saves_place,
700            outgoing: self.calls.unwrap_or(0),
701            locals: &self.locals,
702            grows: self.grown_at.is_some(),
703            ..base
704        }
705    }
706}
707
708/// The x86-64 machine IR for that function.
709///
710/// # Errors
711///
712/// The first instruction no rule fires on, which today is anything at a width the rule set is not
713/// written at, a parameter that does not arrive in a register this can read, or a call that
714/// passes something this cannot put where the convention wants it.
715pub fn func(
716    source: &Func,
717    names: &mut Interner,
718    conv: &'static CallRegs,
719    elsewhere: &Elsewhere,
720) -> Result<Lowered, Unsupported> {
721    Lowering::new(source, names, conv, elsewhere).run()
722}
723
724/// What the matcher settled on for one block, indexed the way the block's instructions are.
725struct Decided {
726    /// What each instruction matched, and nothing for one that matched no rule or was folded
727    /// into a later one.
728    found: Vec<Option<Match<Term>>>,
729    /// How each instruction showed its operands to the matcher, which is what says what it took.
730    plans: Vec<Option<Plan>>,
731    /// The instructions some other instruction took, which are the ones with nothing to write.
732    folded: Vec<Inst>,
733}
734
735/// One function being lowered.
736struct Lowering<'a> {
737    source: &'a Func,
738    names: &'a mut Interner,
739    out: mir::Func,
740    /// The machine register each IR value is in, once it has one.
741    regs: Vec<Option<mir::Reg>>,
742    /// For a constant that has been written into a register, the block it was written into,
743    /// which is the only block that register is any good in.
744    written: Vec<Option<mir::Block>>,
745    /// How many times each IR value is read, which is what says whether an instruction may be
746    /// folded into the one that reads it.
747    uses: Vec<u32>,
748    /// The block being filled.
749    at: Option<mir::Block>,
750    /// The machine IR block each IR block became.
751    blocks: Vec<Option<mir::Block>>,
752    /// The class an address is in, which is the general purpose one and is not a question: every
753    /// register an addressing mode names holds part of an address, and there is no machine here
754    /// that computes an address anywhere but in this file. Which class a *value* is in is
755    /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
756    gpr: RegClass,
757    /// Where the convention this function is compiled for puts things, which is read for the
758    /// arguments and for the calls.
759    conv: &'static CallRegs,
760    /// Which names this function may not work an address out for itself, which is a fact about the
761    /// module and so is worked out before any of this and handed in.
762    elsewhere: &'a Elsewhere,
763    /// What the function wants its stack to look like, filled in as the walk finds out.
764    stack: Stack,
765    /// What a `va_start` in this function has to write, or nothing for a function that takes no
766    /// arguments its signature does not name.
767    ///
768    /// Worked out once, when the entry block binds the parameters, because every number in it is
769    /// about where those parameters left the walk over the argument registers and there is nowhere
770    /// else that knows.
771    varargs: Option<Varargs>,
772    /// Which of the function's stack objects each eighty bit value lives in, once it has asked
773    /// for one.
774    ///
775    /// One slot per value and it is never given back, which is what makes an eighty bit value
776    /// behave like every other one: it is written once and read wherever it is read, and no two
777    /// of them share a slot the way two of them would share a register. What is in a register is
778    /// the address, and that is worked out again at every use rather than kept, so nothing here
779    /// holds a general purpose register open across a whole function.
780    slots: Vec<Option<usize>>,
781    /// The eight bytes a value passes through between a register and the x87 stack, once
782    /// something has wanted them.
783    ///
784    /// One for the whole function, because every group that uses it is a handful of instructions
785    /// with nothing in between: the bytes are written, read straight back and never looked at
786    /// again, so a second slot would be a second slot holding the same nothing.
787    crossing: Option<usize>,
788    /// The four bytes the control word is saved in and the changed copy written to, once
789    /// something has wanted them.
790    ///
791    /// One for the whole function for the reason above, and four rather than two because it is
792    /// two words: the one the unit had and the one with the rounding field turned to truncate.
793    control: Option<usize>,
794    /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
795    ///
796    /// One for the whole function however many saves there are in it, because the word is written
797    /// and read back with nothing in between: the save writes a zero into it and the instruction
798    /// straight after reads it, and the only other thing that ever writes it is a restore arriving
799    /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
800    /// inside the other.
801    answer: Option<usize>,
802    /// Which rules have fired so far.
803    fired: Fired,
804}
805
806/// What a `va_start` in a variadic function writes into the list it is given.
807///
808/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
809/// both are written down. Neither is a set of numbers on its own: where the save area is and where
810/// the caller's argument area is are distances into a frame that does not exist until after
811/// allocation, so each is a `lea` [`crate::finish`] fills in.
812#[derive(Debug, Clone, Copy, PartialEq, Eq)]
813enum Varargs {
814    /// The four field list, whose two offsets are settled here and whose two addresses are not.
815    Fields {
816        /// Which of the function's stack objects is the register save area.
817        save: usize,
818        /// How far up the caller's argument area the first argument the signature does not name is,
819        /// which is the whole of that area the named ones did not take.
820        incoming: u32,
821        /// What `gp_offset` starts at, which is past the general purpose registers the named
822        /// arguments took.
823        integers: u32,
824        /// What `fp_offset` starts at, which is past the vector ones.
825        floats: u32,
826    },
827    /// The list that is a pointer, which is the one address and nothing else.
828    Pointer {
829        /// How far up the caller's argument area the first argument the signature does not name is,
830        /// which on this convention is the word belonging to the position the named ones stopped
831        /// at.
832        incoming: u32,
833    },
834}
835
836/// How far a function's name reaches, narrowed from the linkage the IR gave it.
837///
838/// The IR has five and an object file says three, and the two the linker cannot tell apart are
839/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
840/// no way to record. A function is never `Common`, since that is what a tentative definition of an
841/// object is and there is no tentative definition of a function, and it is written here rather
842/// than left out so that a linkage added later has to come past this.
843const fn binding(linkage: Linkage) -> mir::Binding {
844    match linkage {
845        Linkage::Internal => mir::Binding::Local,
846        Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
847        Linkage::External | Linkage::Common => mir::Binding::Global,
848    }
849}
850
851/// How far a function's name reaches outside a shared library, carried across unchanged.
852///
853/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
854/// three of these and the two enumerations are the same three answers written twice: once in a
855/// crate that is not allowed to know what an object file is and once in one that is.
856const fn visibility(visibility: Visibility) -> mir::Visibility {
857    match visibility {
858        Visibility::Default => mir::Visibility::Default,
859        Visibility::Hidden => mir::Visibility::Hidden,
860        Visibility::Protected => mir::Visibility::Protected,
861    }
862}
863
864impl<'a> Lowering<'a> {
865    fn new(
866        source: &'a Func,
867        names: &'a mut Interner,
868        conv: &'static CallRegs,
869        elsewhere: &'a Elsewhere,
870    ) -> Self {
871        let counts = source.counts();
872        let name = source.name;
873        let mut uses = vec![0; counts.values];
874        for block in source.blocks() {
875            for inst in source.insts(block) {
876                for &arg in &source[source[inst].args] {
877                    uses[arg.index()] += 1;
878                }
879                for call in source.successors(inst) {
880                    for &arg in &source[call.args] {
881                        uses[arg.index()] += 1;
882                    }
883                }
884            }
885        }
886        let mut out = mir::Func::new(name);
887        out.align = source.align;
888        // Carried rather than worked out here, because where a function was declared is a fact
889        // about the source and this is a long way past it. What wants it is the line table.
890        out.declared = source.declared;
891        out.binding = binding(source.linkage);
892        out.visibility = visibility(source.visibility);
893        Self {
894            source,
895            names,
896            out,
897            regs: vec![None; counts.values],
898            written: vec![None; counts.values],
899            blocks: vec![None; counts.blocks],
900            uses,
901            at: None,
902            gpr: x86_64::GPR,
903            conv,
904            elsewhere,
905            stack: Stack::default(),
906            varargs: None,
907            slots: vec![None; counts.values],
908            crossing: None,
909            control: None,
910            answer: None,
911            fired: Fired::new(),
912        }
913    }
914
915    fn run(mut self) -> Result<Lowered, Unsupported> {
916        // Every block before any of them is filled, because a block that jumps forward has to
917        // name the block it jumps to and a machine IR block is named by a handle rather than by
918        // the IR block it came from.
919        for block in self.source.blocks() {
920            let out = self.out.create_block();
921            self.blocks[block.index()] = Some(out);
922        }
923        for block in self.order() {
924            self.block(block)?;
925        }
926        // And the name each block an image holds the address of was given, which nothing in the
927        // walk above would ask for: the `lea` a label address is inside the function needs no
928        // symbol, and the one thing that does is a relocation in another section.
929        let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
930        let labels: Vec<(mir::Block, Symbol)> =
931            named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
932        self.out.labels = labels;
933        self.naming();
934        Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
935    }
936
937    /// Which register each declaration the front end kept in a value ended up in, as far as this
938    /// walk can say, which is the other half of what [`Lowering::new_reg`] writes down as it goes.
939    ///
940    /// Two halves because there are two ways a value gets a register here. Most of them ask for a
941    /// fresh one and that is where `new_reg` catches them, and the rest are put in a register
942    /// something else chose: a parameter arrives in whichever one the convention handed it, a block
943    /// parameter in whichever one the edge agreed on, and a result of a rule that names its own
944    /// registers in the one the rule named. None of those goes past the mint, so this is the map at
945    /// the end read off the other side, and the two together are every value a declaration is
946    /// behind.
947    ///
948    /// The map on its own would not do, which is why `new_reg` writes down what it writes down: the
949    /// entry for a constant is cleared every time the walk leaves the block that wrote it, so a
950    /// local a constant holds is in the map for one block of the function and nowhere else.
951    fn naming(&mut self) {
952        let mut named = std::mem::take(&mut self.out.named);
953        for value in self.source.values() {
954            let Some(reg) = self.regs[value.index()] else { continue };
955            named.extend(self.source.value_decls(value).map(|decl| (decl, reg)));
956        }
957        named.sort_unstable();
958        named.dedup();
959        self.out.named = named;
960    }
961
962    /// The order the blocks are filled in, which is not the order they are written in.
963    ///
964    /// Reverse postorder, because a value is written in a block that dominates every block that
965    /// reads it and a block in reverse postorder comes before every block it dominates. The order
966    /// the blocks are written in does not have that property: a block written early can read a
967    /// value a block below it writes, and reading a value with no register yet mints one, so the
968    /// register the definition writes later is not the register the read named. Nothing writes the
969    /// one the read named, and what comes out is a function that loads a stack slot no store ever
970    /// reached. It is the order this walk goes in rather than the order the blocks come out in,
971    /// which is what the loop above fixes, so the machine function is still written the way the IR
972    /// function was.
973    ///
974    /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
975    /// them and nothing they name is read by anything that does, but they still have to be filled,
976    /// because a machine block with no terminator is not one the passes below can read.
977    fn order(&self) -> Vec<Block> {
978        let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
979        let count = self.blocks.len();
980        let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
981        for block in self.source.blocks() {
982            let Some(term) = self.source.terminator(block) else { continue };
983            succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
984        }
985        // An explicit stack, because the depth of the walk is the number of blocks and a function
986        // built by a generator has as many of those as it likes.
987        let mut seen = vec![false; count];
988        let mut order = Vec::with_capacity(count);
989        let mut stack = vec![(entry, 0usize)];
990        seen[entry.index()] = true;
991        while let Some((block, at)) = stack.pop() {
992            let Some(&next) = succs[block.index()].get(at) else {
993                order.push(block);
994                continue;
995            };
996            stack.push((block, at + 1));
997            if !seen[next.index()] {
998                seen[next.index()] = true;
999                stack.push((next, 0));
1000            }
1001        }
1002        order.reverse();
1003        order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
1004        order
1005    }
1006
1007    /// One block: its parameters, then every instruction in it that is not folded into another.
1008    fn block(&mut self, block: Block) -> Result<(), Unsupported> {
1009        let out = self.out_block(block);
1010        self.at = Some(out);
1011        if self.source.entry() == Some(block) {
1012            self.arrive(block, out)?;
1013        } else {
1014            let mut arriving = Vec::new();
1015            for &param in &self.source[block].params {
1016                // A value with no register to arrive in, which the class would not say, since
1017                // `class_of` puts one of these in the general purpose file on purpose and what it
1018                // means by that is that nothing there can hold it. What crosses the edge for one
1019                // of those is the address of where the value already is, so the parameter is a
1020                // pointer here and the bytes it points at are copied below.
1021                let ty = self.source[param].ty;
1022                let reg = self.out.append_param(out, self.class_of(ty));
1023                self.regs[param.index()] = Some(reg);
1024                if on_x87(ty) {
1025                    arriving.push((param, reg));
1026                }
1027            }
1028            self.settle(block, &arriving)?;
1029        }
1030
1031        // What each instruction matched, and which instructions were folded into another. The
1032        // decision is made for the whole block before any of it is written, and it is made more
1033        // than once: a value that only some of its readers took has to be put back in a register
1034        // for all of them, and taking it away from those readers changes what they match.
1035        let insts: Vec<Inst> = self.source.insts(block).collect();
1036        let mut refused: HashSet<Value> = HashSet::new();
1037        let mut decided = self.decide(&insts, &refused);
1038        while let Some(value) = self.left_alive(&insts, &decided.plans) {
1039            refused.insert(value);
1040            decided = self.decide(&insts, &refused);
1041        }
1042        let Decided { found, folded, .. } = decided;
1043
1044        for (&inst, matched) in insts.iter().zip(found) {
1045            if folded.contains(&inst) || self.writes_nothing(inst) {
1046                continue;
1047            }
1048            // A call is built from the convention rather than matched, which is why it is the one
1049            // opcode looked at by name here. Through an address it is a different instruction and
1050            // the same convention, so the two arrive at the same place and differ in one line of
1051            // it.
1052            match self.source[inst].opcode {
1053                Opcode::Call | Opcode::CallIndirect => {
1054                    self.called(inst)?;
1055                    continue;
1056                }
1057                // Built from the frame rather than matched, for the same shape of reason a call
1058                // is built from the convention: what a rule replaces a term with is instructions,
1059                // and what an `alloca` needs first is bytes, which the rule language has no way
1060                // to ask for.
1061                Opcode::Alloca => {
1062                    self.reserve(inst)?;
1063                    continue;
1064                }
1065                // Reading the stack pointer and writing it back, which are the two ends of a scope
1066                // holding a variable length array. Built here for the reason an `alloca` is: the
1067                // value is a register the rule language has no way to name, because what it holds
1068                // is not a value the program computed but where the machine's stack had got to.
1069                Opcode::StackSave => {
1070                    self.stack_pointer(inst, false)?;
1071                    continue;
1072                }
1073                Opcode::StackRestore => {
1074                    self.stack_pointer(inst, true)?;
1075                    continue;
1076                }
1077                // The address of a name, built here for the same reason an `alloca` is: what a
1078                // rule replaces a term with is instructions over values, and the operand of this
1079                // one is a symbol, which is a thing the rule language has no way to bind and the
1080                // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
1081                // proof over bitvectors could discharge, because what makes it the right answer
1082                // is the relocation and what the linker does with it.
1083                Opcode::GlobalAddr => {
1084                    self.address_of(inst)?;
1085                    continue;
1086                }
1087                // The address of a label and the branch that reads one, built here for the same
1088                // reason and for one more. The reason is the same: what the first of them names is
1089                // a block, which is not a value a rule pattern can bind, and there is nothing in
1090                // the distance between two places in one function that a proof over bitvectors
1091                // could discharge. The extra one is that the second is a terminator whose arms are
1092                // not two and not fixed, and a rule says what an instruction reads rather than
1093                // where a block goes.
1094                Opcode::BlockAddr => {
1095                    self.block_address(inst)?;
1096                    continue;
1097                }
1098                Opcode::IndirectBr => {
1099                    self.indirect_branch(inst)?;
1100                    continue;
1101                }
1102                // The pair that saves a place in this function and comes back to it. Built here
1103                // for the reason the address of a label is, and for two more. The reason is the
1104                // same: the first of them writes down where control comes back to, which is a
1105                // place in this function and not a value a rule pattern can bind. The extra ones
1106                // are that each of them is a group of instructions over a buffer the program owns
1107                // rather than one instruction, and that the first of them leaves the block it was
1108                // written in and carries on in a new one, which is a thing no rule can do.
1109                Opcode::SetjmpMarker => {
1110                    self.saves_place(inst)?;
1111                    continue;
1112                }
1113                Opcode::LongjmpMarker => {
1114                    self.comes_back(inst)?;
1115                    continue;
1116                }
1117                // Where this thread's own storage starts, built here for a reason of the same
1118                // shape: what it reads is `%fs`, which is not a register the rule language can
1119                // bind and not one a proof over bitvectors could say anything about, because what
1120                // makes the load the right answer is an agreement between the loader and the C
1121                // library rather than any arithmetic.
1122                Opcode::ThreadPointer => {
1123                    self.thread_pointer(inst)?;
1124                    continue;
1125                }
1126                // What a named machine register holds, built here for the reason above written
1127                // about any register rather than about one: which register it is is a string
1128                // beside the instruction, and a rule matches on an opcode and a type and could
1129                // not see it. There is nothing to prove either, since the answer is the register
1130                // and the instruction is the move that reads it.
1131                Opcode::RegisterValue => {
1132                    self.register_value(inst)?;
1133                    continue;
1134                }
1135                // Where a frame is and what it returns to, built here for the same reason and one
1136                // more. The reason is the same: what the walk starts from is the frame pointer,
1137                // which is not a register a rule pattern can bind, and there is nothing in reading
1138                // the link the prologue saved that a proof over bitvectors could discharge. The
1139                // extra one is that how long the walk is comes out of a number beside the
1140                // instruction, so one of these is not one instruction but however many the depth
1141                // says, and a rule replaces a term with a term.
1142                Opcode::FrameAddress | Opcode::ReturnAddress => {
1143                    self.frames(inst)?;
1144                    continue;
1145                }
1146                // Built from the frame for the reason an `alloca` is, and from the convention for
1147                // the reason a call is: three of the four fields it writes are distances that do
1148                // not exist until the frame does, and the fourth is where the walk over the
1149                // argument registers stopped. A function that is not variadic has no such walk to
1150                // report, so it has nothing here and is refused below, which is the right answer
1151                // for a `va_start` in one.
1152                Opcode::VaStart if self.varargs.is_some() => {
1153                    self.va_start(inst)?;
1154                    continue;
1155                }
1156                // A return of more than one value, which is a structure small enough to come
1157                // back in a pair of registers. Built from the convention for the reason a call
1158                // is: which register each half goes in depends on the halves in front of it,
1159                // because the two register files are walked separately, and a pattern over a term
1160                // cannot see them. A return of one value is a term with a name and a rule, and it
1161                // stays one.
1162                //
1163                // A return of none in a function whose answer went through memory is here too,
1164                // and for a different reason: what it gives back is not written in the IR at all.
1165                // The convention says the address the caller handed over comes back, and only the
1166                // signature says this function was handed one.
1167                //
1168                // And a return of one eighty bit value, for a third reason: what a rule would
1169                // write is an instruction leaving the value in a register, and this one is left on
1170                // the x87 stack instead. A rule could not name that stack any more than any other
1171                // rule about this type could.
1172                Opcode::Return
1173                    if self.source[self.source[inst].args].len() > 1
1174                        || self.sret().is_some()
1175                        || self.gives_back_x87(inst) =>
1176                {
1177                    self.returned(inst)?;
1178                    continue;
1179                }
1180                // A cast between a pointer and an integer of the same width, which on this
1181                // machine is every one the front end writes. No instruction at all, so no rule
1182                // could name one.
1183                Opcode::PtrToInt | Opcode::IntToPtr => {
1184                    self.rename(inst)?;
1185                    continue;
1186                }
1187                // A barrier, which is one instruction or none depending on the ordering. Written
1188                // by name because there is nothing about it a rule could be proved against, the
1189                // way there is nothing to prove about the address of a symbol.
1190                Opcode::Fence => {
1191                    self.barrier(inst)?;
1192                    continue;
1193                }
1194                // A hint, written by name for the reason a barrier is and one step further: not
1195                // only is there no equality for a proof to discharge, there is nothing about the
1196                // program around it either. Which of the four instructions it is comes out of the
1197                // number the builtin was given, which is beside the instruction rather than in it.
1198                Opcode::Prefetch => {
1199                    self.hint(inst)?;
1200                    continue;
1201                }
1202                // Stopping, written by name for the first half of the barrier's reason: it
1203                // computes nothing, so there is no term for a rule to replace, and what makes it
1204                // right is what the operating system does with the fault rather than anything a
1205                // proof over bitvectors could discharge.
1206                Opcode::Trap => {
1207                    self.trap(inst);
1208                    continue;
1209                }
1210                // A compare and exchange, which is written by name because it produces two values
1211                // and a rule produces one. The replacement of a rule is one term, a term names the
1212                // value an instruction computes, and there is no way in that language to say that
1213                // an instruction leaves an answer in one place and a yes or no in another.
1214                Opcode::Cmpxchg => {
1215                    self.exchange(inst)?;
1216                    continue;
1217                }
1218                // A read modify write, which is written by name for a different reason: it produces
1219                // one value, so a rule could name it, and what it does is not in the head a rule
1220                // matches on. Every one of the thirteen operations is the same opcode at the same
1221                // type and differs only in what is carried beside it, so one pattern would be all
1222                // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1223                // since `crate::retry` turned the rest into loops a long way above this.
1224                Opcode::AtomicRmw => {
1225                    self.modify(inst)?;
1226                    continue;
1227                }
1228                // An `asm` statement, whose lowering is its template and there is no term for a
1229                // string. Written by name for the reason a barrier is, and before the x87 arm
1230                // below so that an `asm` holding a `long double` is refused as the `asm` it is
1231                // rather than as an instruction nothing computes.
1232                Opcode::InlineAsm => {
1233                    self.assembly(inst)?;
1234                    continue;
1235                }
1236                // Anything at all with an eighty bit float in it, which is the one arm here
1237                // chosen by a type rather than by an opcode, because what makes these different
1238                // is not what they do but where the value is. A `long double` has no register,
1239                // so it has no name in `crate::term` and no rule could bind one: every one of
1240                // these is a group of instructions over a frame slot, written out below.
1241                //
1242                // Last of the arms, so that a call and a return with one of these in them reach
1243                // the convention first and are refused by it, which is the truer answer: what is
1244                // wrong there is where the value has to travel and not that nothing can compute
1245                // it.
1246                _ if self.touches_x87(inst) => {
1247                    self.x87(inst)?;
1248                    continue;
1249                }
1250                _ => {}
1251            }
1252            let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1253            self.emit(inst, &matched)?;
1254            // After it is built rather than when it matched, so that what is recorded is the rules
1255            // this function was lowered by and not the rules something was tried with.
1256            self.fired.mark(matched.rule);
1257        }
1258        // Whichever block the walk ended in rather than the one it started in. The two are the
1259        // same block for every function that does not save a place for a `__builtin_longjmp`, and
1260        // where they differ it is the last of them that the terminator and the arms belong to.
1261        // See [`Self::saves_place`].
1262        let last = self.at.expect("a block is being filled");
1263        self.edges(block, last)
1264    }
1265
1266    /// One call, which is built from the convention rather than matched against the table for the
1267    /// same reason the arguments of the function itself are.
1268    ///
1269    /// The arguments are read before the call is built, which is what materializes a constant
1270    /// argument into a register, since no call passes an immediate.
1271    ///
1272    /// A call to a name and a call through an address are both here, and what tells them apart is
1273    /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1274    /// reads. Through an address the first operand is the address and the arguments are the ones
1275    /// behind it, and everything after that is the same: where each argument goes, where the value
1276    /// comes back and which registers are gone across it are the convention's answers and the
1277    /// convention does not ask what is being called.
1278    fn called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1279        let data = &self.source[inst];
1280        let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1281        let info = self.source[info];
1282        let indirect = data.opcode == Opcode::CallIndirect;
1283
1284        let values: Vec<Value> = self.source[data.args].to_vec();
1285        let callee = if indirect {
1286            let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1287            abi::Callee::Through(self.reg_of(address)?)
1288        } else {
1289            abi::Callee::Named(info.callee.ok_or_else(|| self.unsupported(inst))?)
1290        };
1291
1292        // What the ABI asks of each argument, read out before any of them is, because reading one
1293        // borrows the function this is a table in. The ones the signature names are the signature's
1294        // answer and the ones behind them are the call's, which is where a structure passed to a
1295        // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1296        let signature = &self.source[info.signature];
1297        let variadic = signature.variadic;
1298        let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1299        let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1300        // Every value that comes back and not only the first. A structure small enough to travel
1301        // in registers comes back in up to two of them, and which register each half is in is the
1302        // convention's answer, which is why the whole list goes to the same place the arguments do
1303        // rather than to a rule.
1304        let returns: Vec<Type> = signature.return_types().collect();
1305
1306        let mut args = Vec::with_capacity(values.len());
1307        for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1308            let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1309            let abi = abi.copied().unwrap_or_default();
1310            let ty = self.source[value].ty;
1311            // What travels for an eighty bit value is its bytes, so what the call is handed is
1312            // where they are rather than a register they are in, and there is no register they
1313            // could be in. Everything else about it is a sixteen byte object passed by value and
1314            // is built by the same code.
1315            let reg =
1316                if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1317            args.push(abi::Passing { ty, reg, abi });
1318        }
1319        let block = self.at.expect("a block is being filled");
1320        let what = abi::Calling {
1321            callee,
1322            args: &args,
1323            returns: &returns,
1324            variadic,
1325            named: named.len(),
1326            at: self.source.span(inst),
1327        };
1328        let made = abi::call(&mut self.out, block, &what, self.conv, self.names)
1329            .map_err(|refused| Unsupported::Call { inst, refused })?;
1330        let calls = &mut self.stack.calls;
1331        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1332        // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1333        // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1334        // front of everything the block does next, and after it the value is in its slot and is
1335        // read the way every other one is.
1336        let results: Vec<Value> = self.source[inst].results().collect();
1337        if let [result] = results[..] {
1338            if abi::on_the_stack(self.source[result].ty) {
1339                let span = self.source.span(inst);
1340                let into = self.x87_slot(result);
1341                let into = self.through(into);
1342                self.x87_at("fstp_t", span, into);
1343                return Ok(());
1344            }
1345        }
1346        for (result, &reg) in results.into_iter().zip(&made.results) {
1347            self.regs[result.index()] = Some(reg);
1348        }
1349        Ok(())
1350    }
1351
1352    /// The pointer a function returning through memory was handed, or nothing in a function that
1353    /// was not.
1354    ///
1355    /// It is the first parameter and the signature is what says so, since in the IR it is an
1356    /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1357    /// like that and no entry block has nothing to give back and no body to give it back from.
1358    fn sret(&self) -> Option<Value> {
1359        let first = self.source.signature().params.first()?;
1360        if !matches!(first.abi, Abi::Sret { .. }) {
1361            return None;
1362        }
1363        self.source[self.source.entry()?].params.first().copied()
1364    }
1365
1366    /// One `return` the convention has to write, as the place each value has to be in by the end.
1367    ///
1368    /// One pseudo per value, each a read constrained to a return register, which is what a return
1369    /// of one value already is and is the whole of what either does. The `ret` itself comes from
1370    /// the epilogue for both, long after this, because the frame has to be given back first.
1371    ///
1372    /// The two register files are counted separately, so a structure of a `double` and a `long`
1373    /// leaves the `double` in the first vector register and the `long` in the first integer one
1374    /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1375    /// the other side of the call, which is what makes the two ends agree.
1376    ///
1377    /// A function whose answer went through memory gives back the address it was handed, in front
1378    /// of nothing else, because a signature that returns that way returns nothing else. That the
1379    /// caller already knows the address is not enough: it is allowed to read the register instead,
1380    /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1381    /// is usually the right answer by accident, and one call in the body is enough to make it a
1382    /// wild pointer, which is why this is written rather than left to luck.
1383    ///
1384    /// Where everything goes is worked out before anything is written, so a return this cannot
1385    /// make leaves no half of one behind.
1386    /// Whether what a `return` gives back is the one value that goes back on the x87 stack.
1387    fn gives_back_x87(&self, inst: Inst) -> bool {
1388        let [value] = self.source[self.source[inst].args] else { return false };
1389        abi::on_the_stack(self.source[value].ty)
1390    }
1391
1392    fn returned(&mut self, inst: Inst) -> Result<(), Unsupported> {
1393        let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
1394        let (mut ints, mut floats) = (0usize, 0usize);
1395        let mut parts = Vec::with_capacity(values.len() + 1);
1396        // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1397        // and is the one place a value is left rather than put in a register. So the whole of the
1398        // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1399        // `ret`, which is the one time in this file that is true and is what the convention asks
1400        // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1401        // the unit.
1402        if let [value] = values[..] {
1403            let ty = self.source[value].ty;
1404            if abi::on_the_stack(ty) && self.sret().is_none() {
1405                let span = self.source.span(inst);
1406                let from = self.x87_slot(value);
1407                let from = self.through(from);
1408                self.x87_at("fld_t", span, from);
1409                return Ok(());
1410            }
1411        }
1412        for value in self.sret().into_iter().chain(values) {
1413            let ty = self.source[value].ty;
1414            let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1415            // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1416            // says so itself, and a type that travels perfectly well ran out of registers.
1417            let missing = abi::refuses(ty).unwrap_or(Missing::NoRoom);
1418            let name = abi::ret_of(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1419            *at += 1;
1420            // The register is the target's answer and not one worked out here, the same as it is
1421            // for a return of one value, so that both halves of a pair and every rule that writes
1422            // half of one are reading the same table.
1423            let opcode = name.strip_prefix(PREFIX).expect("a machine instruction of this target");
1424            let form = x86_64::form(opcode).ok_or_else(|| self.unsupported(inst))?;
1425            let [desc] = form.operands() else { return Err(self.unsupported(inst)) };
1426            parts.push((self.names.intern(name), self.reg_of(value)?, *desc));
1427        }
1428
1429        let block = self.at.expect("a block is being filled");
1430        let span = self.source.span(inst);
1431        for (opcode, reg, desc) in parts {
1432            let operand = mir::Operand {
1433                reg,
1434                class: desc.class,
1435                role: desc.role,
1436                constraint: desc.constraint,
1437            };
1438            self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1439        }
1440        Ok(())
1441    }
1442
1443    /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1444    /// address of them is one instruction.
1445    ///
1446    /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1447    /// the frame in every function, and its displacement is left at nothing because there is no
1448    /// frame yet. Which instruction is waiting for which local is remembered, and
1449    /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1450    ///
1451    /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1452    /// that is what stops it being folded into something else. An operand shown as the
1453    /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1454    /// name is one no pattern can reach past, and the address it computes is always in a register
1455    /// by the time anything reads it.
1456    fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1457        let data = &self.source[inst];
1458        // A variable length array carries the size it wants as an operand rather than in the
1459        // instruction, which is the whole of what tells the two apart here.
1460        if let Some(&size) = self.source[data.args].first() {
1461            return self.grow(inst, size);
1462        }
1463        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1464        let info = self.source[mem];
1465        let size = u32::try_from(info.size)
1466            .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1467        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1468
1469        // At least one, because the frame divides by the alignment and an object with no
1470        // alignment at all is one the front end had nothing to say about rather than one that may
1471        // go anywhere.
1472        let index = self.stack.locals.len();
1473        self.stack.locals.push(Local { size, align: info.align.max(1) });
1474        if let Some(decl) = self.source.mem_decl(mem) {
1475            self.stack.declared.push((index, decl));
1476        }
1477
1478        let block = self.at.expect("a block is being filled");
1479        let reg = self.new_reg(result);
1480        let span = self.source.span(inst);
1481        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
1482        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1483        let made =
1484            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1485        self.stack.addresses.push((made, index));
1486        Ok(())
1487    }
1488
1489    /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1490    /// is what a variable length array is.
1491    ///
1492    /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1493    /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1494    /// where the declaration stands, which is two instructions:
1495    ///
1496    /// ```text
1497    ///   sub sp, bytes     the stack pointer moves down over the memory, which is what takes it
1498    ///   lea reg, [sp+n]   where the memory starts, which is above the outgoing argument area
1499    /// ```
1500    ///
1501    /// The displacement is left at nothing for the reason the constant kind leaves its own at
1502    /// nothing, and for a different number: that area belongs to the arguments of whatever this
1503    /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1504    /// how big it is is not known until every call in the function has been seen.
1505    ///
1506    /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1507    /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1508    /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1509    ///
1510    /// Two instructions here and not always two in the finished function. On a command line that
1511    /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1512    /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1513    /// instruction is written down in [`Stack::grown`] as well as left where it is.
1514    ///
1515    /// An array wanting more alignment than the convention leaves the stack pointer with does not
1516    /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1517    /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1518    /// is a block asking for the convention's alignment like any other. The refusal below is what
1519    /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1520    /// would be a second rounding of a register the frame already rounded, and after it no
1521    /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1522    fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1523        let data = &self.source[inst];
1524        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1525        let info = self.source[mem];
1526        if info.align > self.conv.stack_align {
1527            return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1528        }
1529        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1530        let bytes = self.reg_of(size)?;
1531
1532        let block = self.at.expect("a block is being filled");
1533        let span = self.source.span(inst);
1534        let stack = mir::Reg::physical(self.conv.stack_pointer);
1535        let grow = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.grow)));
1536        let took = self
1537            .out
1538            .build(block, grow)
1539            .at(span)
1540            .operand(mir::Operand::write(stack, self.gpr))
1541            .operand(mir::Operand::read(stack, self.gpr))
1542            .operand(mir::Operand::read(bytes, self.gpr))
1543            .finish();
1544        self.stack.grown.push(took);
1545
1546        let reg = self.new_reg(result);
1547        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
1548        let sp = mir::Operand::read(stack, self.gpr);
1549        let made =
1550            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1551        self.stack.dynamic.push(made);
1552        self.stack.grown_at.get_or_insert(inst);
1553        Ok(())
1554    }
1555
1556    /// Where the stack pointer is, kept so that something later can put it back.
1557    ///
1558    /// One move out of the stack pointer and one move into it, which is the whole of what the two
1559    /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1560    /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1561    /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1562    /// jump out of the scope gives the bytes back on the way out.
1563    ///
1564    /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1565    /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
1566    /// which is exactly the register that still means something after the stack pointer has moved.
1567    fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
1568        let data = &self.source[inst];
1569        let block = self.at.expect("a block is being filled");
1570        let span = self.source.span(inst);
1571        let stack = mir::Reg::physical(self.conv.stack_pointer);
1572        let mov = x86_64::FRAME.moves(self.gpr).expect("a class the target says how to move").mov;
1573        let mov = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{mov}")));
1574        let (write, read) = if into {
1575            let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
1576            (stack, self.reg_of(saved)?)
1577        } else {
1578            let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1579            (self.new_reg(result), stack)
1580        };
1581        self.out
1582            .build(block, mov)
1583            .at(span)
1584            .operand(mir::Operand::write(write, self.gpr))
1585            .operand(mir::Operand::read(read, self.gpr))
1586            .finish();
1587        // Only the write is a move of the stack pointer, and it is the one that makes the frame a
1588        // growing one. A read of it in a function that never writes it back is a function that
1589        // asked where the stack was and did nothing with the answer.
1590        if into {
1591            self.stack.grown_at.get_or_insert(inst);
1592        }
1593        Ok(())
1594    }
1595
1596    /// Whether an instruction has an eighty bit float anywhere in it.
1597    ///
1598    /// Producing one and reading one are the same question here, because what makes one of these
1599    /// different from every other instruction is not the operation but where the value is. A
1600    /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
1601    /// of the time, and neither of those is somewhere the operand of a rule could point.
1602    fn touches_x87(&self, inst: Inst) -> bool {
1603        let data = &self.source[inst];
1604        data.results().any(|value| on_x87(self.source[value].ty))
1605            || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
1606    }
1607
1608    /// Everything that happens to an eighty bit float, as the group of instructions it is.
1609    ///
1610    /// The first six move one, and every one of those is a load, a store, or a load and a store at
1611    /// two different formats, because that is the whole of what this machine converts with: the
1612    /// x87 has no instruction that turns one thing on its stack into another, so a widening is
1613    /// `fld` of the narrow format and a narrowing is `fstp` of it.
1614    ///
1615    /// The rest work on one, and they are here rather than in a rule for the same reason the six
1616    /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
1617    /// top of a stack nothing allocates from, so there is no value in the middle of the group for
1618    /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
1619    /// two instructions folded into one opcode, which is where the byte it produces comes from.
1620    ///
1621    /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
1622    /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
1623    /// below is answered by a pop a line or two later, so no two groups can ever be looking at
1624    /// the same eight registers.
1625    fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
1626        match self.source[inst].opcode {
1627            Opcode::Load => self.x87_load(inst),
1628            Opcode::Store => self.x87_store(inst),
1629            Opcode::FPExt => self.x87_widen(inst),
1630            Opcode::FPTrunc => self.x87_narrow(inst),
1631            Opcode::SIToFP => self.x87_from_signed(inst),
1632            Opcode::FPToSI => self.x87_to_signed(inst),
1633            Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
1634            Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
1635            Opcode::FMul => self.x87_arith(inst, "fmul_p"),
1636            Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
1637            Opcode::FNeg => self.x87_flip(inst),
1638            Opcode::FCmp => self.x87_compare(inst),
1639            Opcode::FConst => self.x87_const(inst),
1640            _ => Err(self.unsupported(inst)),
1641        }
1642    }
1643
1644    /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
1645    /// into slots of the block's own.
1646    ///
1647    /// What crosses an edge for a value of this type is an address, because the value is sixteen
1648    /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
1649    /// second edge into the same block hands over a second one, and a read after the block would
1650    /// then be a read of whichever edge was taken rather than of one place. So the block has a
1651    /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
1652    /// every other type gets from the allocator.
1653    ///
1654    /// Every load runs before every store and the stores run backwards, so all of the values are
1655    /// on the x87 stack at once and nothing reads a slot another one has already written. That
1656    /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
1657    /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
1658    /// deep, and a block with more of these than that is refused rather than copied in an order
1659    /// that could be wrong.
1660    fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
1661        let Some(&(first, _)) = arriving.first() else { return Ok(()) };
1662        if arriving.len() > X87_DEPTH {
1663            let ty = self.source[first].ty;
1664            return Err(Unsupported::Phi { block, count: arriving.len(), ty });
1665        }
1666        // A block parameter comes from no instruction, so what this points at is the first thing
1667        // in the block, which is where a reader looking for the copy would look.
1668        let first_inst = self.source.insts(block).next();
1669        let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
1670        for &(_, reg) in arriving {
1671            let from = self.through(reg);
1672            self.x87_at("fld_t", span, from);
1673        }
1674        for &(param, _) in arriving.iter().rev() {
1675            let into = self.x87_slot(param);
1676            let into = self.through(into);
1677            self.x87_at("fstp_t", span, into);
1678        }
1679        Ok(())
1680    }
1681
1682    /// The frame slot an eighty bit value lives in, as its address in a fresh register.
1683    ///
1684    /// The slot is the value's for the whole function and is taken the first time somebody asks.
1685    /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
1686    /// address kept in a register from the definition to the last use would hold a general purpose
1687    /// register open across everything in between, and a function with a handful of these in it
1688    /// would spend its registers on addresses of things rather than on things.
1689    fn x87_slot(&mut self, value: Value) -> mir::Reg {
1690        // An argument of the function has a slot already and it is the caller's. The convention
1691        // puts the bytes in the argument area and hands over where they are, so the address that
1692        // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
1693        // value of this type once it exists, so nothing writes to the caller's copy either. A
1694        // parameter of any other block is not this: what arrived there is an address a predecessor
1695        // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
1696        // bytes landed in is the one below.
1697        let entry = self.source.entry();
1698        if let (Def::Param { block, .. }, Some(reg)) =
1699            (self.source[value].def, self.regs[value.index()])
1700        {
1701            if entry == Some(block) {
1702                return reg;
1703            }
1704        }
1705        let index = match self.slots[value.index()] {
1706            Some(index) => index,
1707            None => {
1708                let index = self.stack.locals.len();
1709                self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
1710                self.slots[value.index()] = Some(index);
1711                index
1712            }
1713        };
1714        let block = self.at.expect("a block is being filled");
1715        self.frame_address(block, index)
1716    }
1717
1718    /// The bytes a value crosses between a register and the x87 stack through, as their address
1719    /// in a fresh register.
1720    fn x87_crossing(&mut self) -> mir::Reg {
1721        let index = match self.crossing {
1722            Some(index) => index,
1723            None => {
1724                let index = self.stack.locals.len();
1725                self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
1726                self.crossing = Some(index);
1727                index
1728            }
1729        };
1730        let block = self.at.expect("a block is being filled");
1731        self.frame_address(block, index)
1732    }
1733
1734    /// The two control words, as the address of the first of them in a fresh register.
1735    fn x87_control(&mut self) -> mir::Reg {
1736        let index = match self.control {
1737            Some(index) => index,
1738            None => {
1739                let index = self.stack.locals.len();
1740                self.stack.locals.push(Local { size: 4, align: 4 });
1741                self.control = Some(index);
1742                index
1743            }
1744        };
1745        let block = self.at.expect("a block is being filled");
1746        self.frame_address(block, index)
1747    }
1748
1749    /// An address held in a register, as the addressing mode that reaches it.
1750    fn through(&self, reg: mir::Reg) -> mir::Mem {
1751        mir::Mem::at(mir::Operand::read(reg, self.gpr))
1752    }
1753
1754    /// One instruction of a group, which names an address and nothing else.
1755    ///
1756    /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
1757    /// the mnemonic rather than in an operand, so there is no register to write down and no
1758    /// register the allocator gets a say in.
1759    fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
1760        let block = self.at.expect("a block is being filled");
1761        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1762        self.out.build(block, opcode).at(span).mem(at).finish();
1763    }
1764
1765    /// The one instruction of a group that reaches the program's own memory.
1766    ///
1767    /// A `long double` moves in two instructions with a frame slot at one end of them, and the
1768    /// other end is the address the program wrote. That end is the access, so it is the one that
1769    /// carries what the program said about it, and the trip through the slot is this compiler's
1770    /// own business the way a spill is. See [`Self::carried`].
1771    fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
1772        let block = self.at.expect("a block is being filled");
1773        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1774        let (span, flags) = (self.source.span(inst), self.carried(inst));
1775        self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
1776    }
1777
1778    /// One instruction of a group that names nothing at all.
1779    ///
1780    /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
1781    /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
1782    /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
1783    /// from. What it works on is which two pushes came before it, which is a fact about the order
1784    /// of the group and is why the group is written in one place.
1785    fn x87_only(&mut self, name: &str, span: Span) {
1786        let block = self.at.expect("a block is being filled");
1787        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1788        self.out.build(block, opcode).at(span).finish();
1789    }
1790
1791    /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
1792    ///
1793    /// Two instructions rather than the two general purpose moves the same sixteen bytes would
1794    /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
1795    /// in the format it was already in and comes back off in it, so a signalling NaN stays one
1796    /// and nothing is raised. Which is what makes this a copy at all.
1797    fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
1798        let (args, result) = self.ends(inst)?;
1799        let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
1800        let span = self.source.span(inst);
1801        let from = self.reg_of(address)?;
1802        let from = self.through(from);
1803        let into = self.x87_slot(result);
1804        let into = self.through(into);
1805        self.x87_touching("fld_t", inst, from);
1806        self.x87_at("fstp_t", span, into);
1807        Ok(())
1808    }
1809
1810    /// A `store` of a `long double`: the same pair the other way round.
1811    fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
1812        let args = self.source[self.source[inst].args].to_vec();
1813        let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
1814        let span = self.source.span(inst);
1815        let from = self.x87_slot(value);
1816        let from = self.through(from);
1817        let into = self.reg_of(address)?;
1818        let into = self.through(into);
1819        self.x87_at("fld_t", span, from);
1820        self.x87_touching("fstp_t", inst, into);
1821        Ok(())
1822    }
1823
1824    /// A `float`, a `double` or an integer becoming a `long double`.
1825    ///
1826    /// Through memory, because the x87 reads memory and nothing else: the value is in a register
1827    /// the machine has and the unit has no way to be handed one, so it is written to the crossing
1828    /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
1829    /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
1830    /// sixty four bit integer outright, so none of the four can round and none can raise.
1831    fn x87_across(
1832        &mut self,
1833        inst: Inst,
1834        put: &'static str,
1835        class: RegClass,
1836        get: &'static str,
1837    ) -> Result<(), Unsupported> {
1838        let (args, result) = self.ends(inst)?;
1839        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1840        let span = self.source.span(inst);
1841        let value = self.reg_of(source)?;
1842        let across = self.x87_crossing();
1843        let across = self.through(across);
1844        let into = self.x87_slot(result);
1845        let into = self.through(into);
1846
1847        let block = self.at.expect("a block is being filled");
1848        let store = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{put}")));
1849        self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
1850        self.x87_at(get, span, across);
1851        self.x87_at("fstp_t", span, into);
1852        Ok(())
1853    }
1854
1855    /// A `long double` becoming a `float`, a `double` or an integer.
1856    ///
1857    /// Through memory for the reason above and in the same three instructions backwards. The two
1858    /// that go to a float round to nearest, which is what the control word says unless somebody
1859    /// has changed it and is what C wants. The two that go to an integer do not, which is why they
1860    /// do not come here.
1861    fn x87_back(
1862        &mut self,
1863        inst: Inst,
1864        put: &'static str,
1865        get: &'static str,
1866        class: RegClass,
1867    ) -> Result<(), Unsupported> {
1868        let (args, result) = self.ends(inst)?;
1869        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1870        let span = self.source.span(inst);
1871        let from = self.x87_slot(source);
1872        let from = self.through(from);
1873        let across = self.x87_crossing();
1874        let across = self.through(across);
1875
1876        self.x87_at("fld_t", span, from);
1877        self.x87_at(put, span, across);
1878        let block = self.at.expect("a block is being filled");
1879        let reg = self.new_reg(result);
1880        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{get}")));
1881        self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
1882        Ok(())
1883    }
1884
1885    /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
1886    fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
1887        let sse = self.conv.sse_class;
1888        match self.source[self.narrow(inst)?].ty.bits() {
1889            32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
1890            64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
1891            _ => Err(self.unsupported(inst)),
1892        }
1893    }
1894
1895    /// An `fptrunc` down from a `long double`, which is the other direction of the same.
1896    fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
1897        let sse = self.conv.sse_class;
1898        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
1899        match self.source[result].ty.bits() {
1900            32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
1901            64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
1902            _ => Err(self.unsupported(inst)),
1903        }
1904    }
1905
1906    /// A `sitofp` up to a `long double`.
1907    ///
1908    /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
1909    /// before it converts one and the front end writes that widening down. An unsigned integer is
1910    /// not here at all: `fild` reads its operand as signed, so a value above the signed range
1911    /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
1912    /// rather than a move and waits with the rest of it.
1913    fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
1914        let gpr = self.gpr;
1915        match self.source[self.narrow(inst)?].ty.bits() {
1916            32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
1917            64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
1918            _ => Err(self.unsupported(inst)),
1919        }
1920    }
1921
1922    /// An `fptosi` down from a `long double`, which is the one conversion here with no single
1923    /// instruction behind it.
1924    ///
1925    /// C cuts towards zero and the unit rounds the way its control word says, so the store that
1926    /// takes the value off the stack is wrapped in the control word being saved, changed and put
1927    /// back. Five instructions around the one that does the work, and three more moving the word
1928    /// through a register, because this machine has no way to OR a constant into memory at this
1929    /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
1930    /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
1931    /// that can gate an instruction on a feature yet.
1932    fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
1933        let (args, result) = self.ends(inst)?;
1934        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1935        let (put, get) = match self.source[result].ty.bits() {
1936            32 => ("fistp_l", "mov_rm_32"),
1937            64 => ("fistp_ll", "mov_rm_64"),
1938            _ => return Err(self.unsupported(inst)),
1939        };
1940        let span = self.source.span(inst);
1941        let gpr = self.gpr;
1942        let from = self.x87_slot(source);
1943        let from = self.through(from);
1944        let across = self.x87_crossing();
1945        let across = self.through(across);
1946        let control = self.x87_control();
1947        let saved = self.through(control).plus(0);
1948        let cut = self.through(control).plus(2);
1949
1950        // The word the unit has now, into the first of the two slots and into a register, with the
1951        // rounding field turned to truncate on the way to the second.
1952        self.x87_at("fnstcw", span, saved);
1953        let block = self.at.expect("a block is being filled");
1954        let was = self.out.new_vreg(gpr);
1955        let read = mir::Opcode::new(self.names.intern("x64.mov_rm_16"));
1956        self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
1957        let now = self.out.new_vreg(gpr);
1958        let set = mir::Opcode::new(self.names.intern("x64.or_ri_16"));
1959        // Two address, which is written out here rather than taken from the two shorthands
1960        // because the shorthands leave an operand unconstrained: this machine ORs into the
1961        // register it read, so the two have to be the same one and only the constraint says so.
1962        self.out
1963            .build(block, set)
1964            .at(span)
1965            .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
1966            .operand(mir::Operand::read(was, gpr))
1967            .imm(X87_TRUNCATE)
1968            .finish();
1969        let write = mir::Opcode::new(self.names.intern("x64.mov_mr_16"));
1970        self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
1971
1972        // The conversion itself, under the changed word, and then the word the unit had put back
1973        // before anything else runs.
1974        self.x87_at("fldcw", span, cut);
1975        self.x87_at("fld_t", span, from);
1976        self.x87_at(put, span, across);
1977        self.x87_at("fldcw", span, saved);
1978
1979        let block = self.at.expect("a block is being filled");
1980        let reg = self.new_reg(result);
1981        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{get}")));
1982        self.out.build(block, load).at(span).def(reg, gpr).mem(across).finish();
1983        Ok(())
1984    }
1985
1986    /// A constant of this type, as the bits of it written into its slot.
1987    ///
1988    /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
1989    /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
1990    /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
1991    ///
1992    /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
1993    /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
1994    /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
1995    /// wide and they are unspecified in the psABI rather than zero.
1996    ///
1997    /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
1998    /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
1999    /// four instructions in the frame is what that costs until it does.
2000    fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
2001        let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
2002        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2003        let bits = self.source[imm].bits();
2004        let span = self.source.span(inst);
2005        let gpr = self.gpr;
2006        let slot = self.x87_slot(result);
2007        let low = self.through(slot).plus(0);
2008        let high = self.through(slot).plus(8);
2009
2010        let block = self.at.expect("a block is being filled");
2011        for (bytes, at, into) in
2012            [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
2013        {
2014            let held = self.out.new_vreg(gpr);
2015            let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_{into}")));
2016            self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
2017            let store = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_mr_{into}")));
2018            self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
2019        }
2020        Ok(())
2021    }
2022
2023    /// One arithmetic instruction on two eighty bit values, as the four it takes.
2024    ///
2025    /// The left operand is pushed first and the right one on top of it, so the left ends up
2026    /// underneath and the answer wanted is the one below against the top in that order. Which of
2027    /// the two mnemonics computes that is a question about the spelling rather than about the
2028    /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
2029    /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
2030    /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
2031    /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
2032    ///
2033    /// An addition and a multiplication have one form each and do not care, which is why a test
2034    /// that reads the mnemonic back would not have caught this and one that computes a subtraction
2035    /// and checks the answer does.
2036    ///
2037    /// The answer is left where the deeper of the two was and the shallower is gone, which is what
2038    /// the `p` on the mnemonic means, so one push has already been paid back by the time the
2039    /// `fstp` runs and the stack is level again after it.
2040    ///
2041    /// Nothing here is folded and nothing is reused. Two values that are the same value get two
2042    /// pushes of the same slot, and an operand that was just computed is read back out of the slot
2043    /// it was written to rather than left on the stack, which costs a store and a load per
2044    /// instruction in an expression. Keeping a partial result on the stack across the next
2045    /// instruction's operands means knowing how deep the stack is at every point in the block, and
2046    /// that is a different thing from writing a group.
2047    fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
2048        let (args, result) = self.ends(inst)?;
2049        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2050        let span = self.source.span(inst);
2051        let left = self.x87_slot(left);
2052        let left = self.through(left);
2053        let right = self.x87_slot(right);
2054        let right = self.through(right);
2055        let into = self.x87_slot(result);
2056        let into = self.through(into);
2057        self.x87_at("fld_t", span, left);
2058        self.x87_at("fld_t", span, right);
2059        self.x87_only(with, span);
2060        self.x87_at("fstp_t", span, into);
2061        Ok(())
2062    }
2063
2064    /// A negation, which is a push, the sign bit turned over and a pop.
2065    ///
2066    /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
2067    /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
2068    /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
2069    /// negative zero and a signalling one at a NaN.
2070    fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
2071        let (args, result) = self.ends(inst)?;
2072        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2073        let span = self.source.span(inst);
2074        let from = self.x87_slot(source);
2075        let from = self.through(from);
2076        let into = self.x87_slot(result);
2077        let into = self.through(into);
2078        self.x87_at("fld_t", span, from);
2079        self.x87_only("fchs", span);
2080        self.x87_at("fstp_t", span, into);
2081        Ok(())
2082    }
2083
2084    /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
2085    ///
2086    /// The right operand is pushed first and the left one on top of it, which is the other way
2087    /// round from the arithmetic and is because `fucomip` asks about the top against what is under
2088    /// it: the comparison this machine can do is the top's, so the value the predicate is about
2089    /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
2090    /// flags are both inside the opcode, since what passes between those and the comparison is the
2091    /// flags and the flags are not something anything here can name.
2092    ///
2093    /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
2094    /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
2095    /// picked a different condition here than there would be a `long double` comparison that
2096    /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
2097    /// wider format is not allowed to do.
2098    ///
2099    /// The always false and the always true are refused rather than folded into a constant,
2100    /// because a comparison this machine never has to do is one the optimizer should have removed
2101    /// and an instruction here that quietly agreed with it would hide that it did not.
2102    fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2103        let Extra::FloatPred(pred) = self.source[inst].extra else {
2104            return Err(self.unsupported(inst));
2105        };
2106        let (args, result) = self.ends(inst)?;
2107        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2108        // Two of the fourteen need a second byte and an instruction to put the two together,
2109        // because they are two conditions at once: an ordered equal is equal and not unordered,
2110        // and an unordered not equal is either. The opcode carries all of that and says here only
2111        // that it writes somewhere else as well.
2112        let (name, reversed, both) = match pred {
2113            FloatPred::Ogt => ("fucomip_set_a", false, false),
2114            FloatPred::Oge => ("fucomip_set_ae", false, false),
2115            FloatPred::Olt => ("fucomip_set_a", true, false),
2116            FloatPred::Ole => ("fucomip_set_ae", true, false),
2117            FloatPred::One => ("fucomip_set_ne", false, false),
2118            FloatPred::Ord => ("fucomip_set_np", false, false),
2119            FloatPred::Uno => ("fucomip_set_p", false, false),
2120            FloatPred::Ueq => ("fucomip_set_e", false, false),
2121            FloatPred::Ult => ("fucomip_set_b", false, false),
2122            FloatPred::Ule => ("fucomip_set_be", false, false),
2123            FloatPred::Ugt => ("fucomip_set_b", true, false),
2124            FloatPred::Uge => ("fucomip_set_be", true, false),
2125            FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2126            FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2127            FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2128        };
2129        let (top, under) = if reversed { (right, left) } else { (left, right) };
2130
2131        let span = self.source.span(inst);
2132        let gpr = self.gpr;
2133        let under = self.x87_slot(under);
2134        let under = self.through(under);
2135        let top = self.x87_slot(top);
2136        let top = self.through(top);
2137        self.x87_at("fld_t", span, under);
2138        self.x87_at("fld_t", span, top);
2139
2140        let block = self.at.expect("a block is being filled");
2141        let reg = self.new_reg(result);
2142        // Taken before the instruction is started rather than inside it, since both come from the
2143        // same function being built and only one thing at a time may be adding to it.
2144        let spare = both.then(|| self.out.new_vreg(gpr));
2145        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2146        let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2147        if let Some(spare) = spare {
2148            build = build.def(spare, gpr);
2149        }
2150        build.finish();
2151        Ok(())
2152    }
2153
2154    /// The operands and the one result of an instruction that has exactly one.
2155    fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2156        let data = &self.source[inst];
2157        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2158        Ok((&self.source[data.args], result))
2159    }
2160
2161    /// The operand of a conversion, which is the end of it that is not the `long double`.
2162    fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2163        let args = &self.source[self.source[inst].args];
2164        args.first().copied().ok_or_else(|| self.unsupported(inst))
2165    }
2166
2167    /// One `va_start`, as the fields of the list it was handed.
2168    ///
2169    /// On the four field list, two of them are numbers this already knows, and each costs an
2170    /// instruction to put in a register before it can be stored, because the machine here has no
2171    /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2172    /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2173    /// and the caller's argument area is where the parameters that had no register came from, which
2174    /// is the same place and the same fixup a parameter past the sixth already uses.
2175    ///
2176    /// On the list that is a pointer it is the second of those four and nothing else, since the
2177    /// whole of what that list says is where the walk is and the walk starts at the first argument
2178    /// the signature does not name. One `lea` and one store.
2179    ///
2180    /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2181    /// laid out, so that reading this beside that table is the whole of the check.
2182    fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2183        let Some(&list) = self.source[self.source[inst].args].first() else {
2184            return Err(self.unsupported(inst));
2185        };
2186        let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2187        let list = self.reg_of(list)?;
2188        let block = self.at.expect("a block is being filled");
2189        let span = self.source.span(inst);
2190
2191        let (save, incoming) = match started {
2192            Varargs::Pointer { incoming } => (None, incoming),
2193            Varargs::Fields { save, incoming, integers, floats } => {
2194                for (at, count) in [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)] {
2195                    let held = self.out.new_vreg(self.gpr);
2196                    let load = mir::Opcode::new(self.names.intern("x64.mov_ri_32"));
2197                    let build = self.out.build(block, load).at(span);
2198                    build.def(held, self.gpr).imm(i64::from(count)).finish();
2199
2200                    let store = mir::Opcode::new(self.names.intern("x64.mov_mr_32"));
2201                    let mem = self.field(list, at);
2202                    self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2203                }
2204                (Some(save), incoming)
2205            }
2206        };
2207
2208        // The first argument the signature did not name, which is as far up the caller's argument
2209        // area as the ones it did name reached. Nothing here knows where that area is, so the
2210        // distance is recorded the way a parameter read out of it is and finished with it.
2211        let overflow = self.out.new_vreg(self.gpr);
2212        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
2213        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2214        let made = self
2215            .out
2216            .build(block, lea)
2217            .at(span)
2218            .def(overflow, self.gpr)
2219            .mem(mir::Mem::at(sp))
2220            .finish();
2221        self.stack.arguments.push((made, incoming));
2222
2223        // At the front of the list when that address is the whole of it, and at the field the
2224        // layout gives it when there are four, with the save area behind it.
2225        let fields = match save {
2226            None => vec![(0, overflow)],
2227            Some(save) => {
2228                let save = self.frame_address(block, save);
2229                vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2230            }
2231        };
2232        for (at, held) in fields {
2233            let store = mir::Opcode::new(self.names.intern("x64.mov_mr_64"));
2234            let mem = self.field(list, at);
2235            self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2236        }
2237        Ok(())
2238    }
2239
2240    /// One field of a list, as the addressing mode that reaches it.
2241    fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2242        let base = mir::Operand::read(list, self.gpr);
2243        mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2244    }
2245
2246    /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2247    ///
2248    /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2249    /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2250    /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2251    /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2252    /// the encoder emits the relocation, because a call to a name the file does not define needed
2253    /// them first.
2254    ///
2255    /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2256    /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2257    /// this program can work out, and the address of a function this file merely declares is not
2258    /// such a number. The load reads the address out of the slot the linker fills in instead. The
2259    /// linker turns it back into the `lea` when the name turns out to have been here all along,
2260    /// so this is not slower in the case that was already right.
2261    ///
2262    /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2263    /// being folded into the instruction that reads it. Folding it is the right thing to do and
2264    /// is what turns a load of a global from two instructions into one, but it is a separate
2265    /// question about addressing modes and issue #282 is it. Until then the address is in a
2266    /// register before anything uses it, which is correct and one instruction longer.
2267    ///
2268    /// What this does not do is give the name anything to refer to. A module carries its globals
2269    /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2270    /// reference the linker cannot resolve. Issue #293 is the other half.
2271    ///
2272    /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2273    fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2274        let data = &self.source[inst];
2275        let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2276        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2277        if self.elsewhere.thread(symbol) {
2278            return self.thread_address(inst, symbol, result);
2279        }
2280
2281        let block = self.at.expect("a block is being filled");
2282        let reg = self.new_reg(result);
2283        let span = self.source.span(inst);
2284        let (mnemonic, mem) = if self.elsewhere.holds(symbol) {
2285            (GOT_LOAD, mir::Mem::got(symbol))
2286        } else {
2287            (x86_64::FRAME.lea, mir::Mem::of(symbol))
2288        };
2289        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{mnemonic}")));
2290        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2291        Ok(())
2292    }
2293
2294    /// The address of a thread-local variable, which is this thread's copy of it.
2295    ///
2296    /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2297    /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2298    /// thread and they are at different addresses, so a link asked for the distance to the name
2299    /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2300    /// the same reason.
2301    ///
2302    /// What is the same in every thread is where the variable sits inside the block of storage a
2303    /// thread gets, so that offset is what the link writes down, and the address of the running
2304    /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2305    /// front of the block, so the whole of this is three instructions:
2306    ///
2307    /// ```text
2308    /// movq  x@gottpoff(%rip), %off   # how far into the block x sits, which the link fills in
2309    /// movq  %fs:0, %tp               # where this thread's block is, which only the machine knows
2310    /// addq  %tp, %off                # this thread's copy of x
2311    /// ```
2312    ///
2313    /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2314    /// in an executable, which folds the addition into the instruction that uses the address, and
2315    /// the difference is issue #282 rather than anything about threads: nothing here folds an
2316    /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2317    /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2318    /// table slot costs nothing in the case that is common.
2319    ///
2320    /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2321    /// program is already running, and the block this reaches was laid out before it started, so
2322    /// the loader has to find room in that block for the library's variables. glibc keeps a little
2323    /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2324    /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2325    /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2326    ///
2327    /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2328    /// right for a library the program is linked against, and a load that either works or is
2329    /// refused out loud for a library something opens later. What it is never is quietly wrong.
2330    fn thread_address(
2331        &mut self,
2332        inst: Inst,
2333        symbol: Symbol,
2334        result: Value,
2335    ) -> Result<(), Unsupported> {
2336        let block = self.at.expect("a block is being filled");
2337        let span = self.source.span(inst);
2338        let gpr = self.gpr;
2339        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{GOT_LOAD}")));
2340
2341        let offset = self.out.new_vreg(gpr);
2342        self.out
2343            .build(block, load)
2344            .at(span)
2345            .def(offset, gpr)
2346            .mem(mir::Mem::thread(symbol))
2347            .finish();
2348        // The front of the block, which is the one thing on this machine that no instruction can
2349        // work out: `%fs` is not a register a program can read, and what it points at is a word
2350        // holding its own address, so reading through it at zero is how the address is come by.
2351        let pointer = self.out.new_vreg(gpr);
2352        let at = mir::Mem::in_segment(Segment::Fs, 0);
2353        self.out.build(block, load).at(span).def(pointer, gpr).mem(at).finish();
2354
2355        // Two address, spelled out for the reason `x87_to_int` gives: this machine adds into the
2356        // register it read, and only the constraint says the two are the same one.
2357        let reg = self.new_reg(result);
2358        let add = mir::Opcode::new(self.names.intern(&format!("{PREFIX}add_rr_64")));
2359        self.out
2360            .build(block, add)
2361            .at(span)
2362            .operand(mir::Operand::write(reg, gpr).with(Constraint::Reuse(1)))
2363            .operand(mir::Operand::read(offset, gpr))
2364            .operand(mir::Operand::read(pointer, gpr))
2365            .finish();
2366        Ok(())
2367    }
2368
2369    /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
2370    /// in this same function.
2371    ///
2372    /// What the two have in common is the whole of the instruction: an address worked out from
2373    /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
2374    /// reaches anything. What they do not have in common is what fills the four bytes in. A
2375    /// global is a name, so the number is a relocation and the linker writes it. A block is a
2376    /// place in this function, so both ends are in one section and the number is known as soon as
2377    /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
2378    /// jump rather than leaving a relocation behind.
2379    ///
2380    /// Nothing here says the block is one control can arrive at. That is said by the
2381    /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
2382    /// and by nothing else: an address on its own is a number.
2383    fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
2384        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2385        let Some(call) = self.source.successors(inst).next() else {
2386            return Err(self.unsupported(inst));
2387        };
2388        let block = self.at.expect("a block is being filled");
2389        let reg = self.new_reg(result);
2390        let span = self.source.span(inst);
2391        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
2392        let mem = mir::Mem::block(self.out_block(call.block));
2393        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2394        Ok(())
2395    }
2396
2397    /// `goto *p`, GNU's computed goto, which is a jump through a register.
2398    ///
2399    /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
2400    /// block this ends, the way every other arm is, and which of them the address holds is decided
2401    /// while the program runs. So this is one instruction with one operand, and the arms are
2402    /// copied across by [`Self::edges`] like anybody else's.
2403    fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
2404        let data = &self.source[inst];
2405        let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2406        let reg = self.reg_of(address)?;
2407        let block = self.at.expect("a block is being filled");
2408        let span = self.source.span(inst);
2409        let name = x86_64::BRANCH.indirect;
2410        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2411        self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
2412        Ok(())
2413    }
2414
2415    /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
2416    /// somewhere else can bring control back here, and answers zero on the way past.
2417    ///
2418    /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
2419    /// block ends: everything after the save in the IR block is put into a new machine IR block,
2420    /// and the address of that block is what went into the buffer. That is the whole reason the
2421    /// block is split here. An address points at a label, a machine IR block is the only thing in
2422    /// this representation that has one, and a save is in the middle of a block rather than at the
2423    /// end of one.
2424    ///
2425    /// # How the answer gets back
2426    ///
2427    /// Through the frame rather than through a register. The save writes a zero into a word of its
2428    /// own frame, puts the address of that word in the buffer, and the new block reads the word
2429    /// back. The restore writes a one through the address it finds in the buffer before it goes.
2430    /// So one load answers zero on the way past and one on the way back, and neither path has to
2431    /// agree with the other about a register.
2432    ///
2433    /// gcc does it the other way round, with a second block that sets the answer to one and is
2434    /// what the restore arrives at. That block is one nothing in the function jumps to, and a
2435    /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
2436    /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
2437    /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
2438    /// and it needs nothing said anywhere about a block arrived at from outside.
2439    ///
2440    /// # What the allocator is told
2441    ///
2442    /// That every register it hands out is gone at the end of the first block. That is what makes
2443    /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
2444    /// in some other function, and the only two registers that puts back are the stack pointer and
2445    /// the frame pointer, so anything this function still wants has to be in the frame those two
2446    /// reach. It is said with a write of every one of those registers, which is the same thing a
2447    /// call says about the registers a callee may destroy, on an instruction with nothing else on
2448    /// it so that the stores above are not caught up in it.
2449    fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
2450        let data = &self.source[inst];
2451        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2452        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2453        let span = self.source.span(inst);
2454        let buf = self.reg_of(buffer)?;
2455        let at = self.at.expect("a block is being filled");
2456        let gpr = self.gpr;
2457        let moves = x86_64::FRAME.moves(gpr).expect("a class the target says how to move");
2458        let store = self.named(moves.store);
2459        let load = self.named(moves.load);
2460        let lea = self.named(x86_64::FRAME.lea);
2461        let put = self.named(x86_64::FRAME.imm);
2462        let nothing = x86_64::FRAME.pad.expect("a target with an instruction that does nothing");
2463        let nothing = self.named(nothing);
2464        self.stack.saves_place = true;
2465        let answer = self.answer_slot();
2466        let back = self.out.create_block();
2467
2468        // The zero this answers with, into the word a restore writes a one into.
2469        let zero = self.out.new_vreg(gpr);
2470        self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
2471        let mem = self.frame_mem();
2472        let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
2473        self.stack.addresses.push((made, answer));
2474
2475        // The four words: where that word is, where control comes back to, and the two registers
2476        // the restore puts back.
2477        let found = self.frame_address(at, answer);
2478        self.write_word(at, span, store, found, buf, JUMP_ANSWER);
2479        let pc = self.out.new_vreg(gpr);
2480        self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
2481        self.write_word(at, span, store, pc, buf, JUMP_PC);
2482        let frame = mir::Reg::physical(self.conv.frame_pointer);
2483        self.write_word(at, span, store, frame, buf, JUMP_FRAME);
2484        let stack = mir::Reg::physical(self.conv.stack_pointer);
2485        self.write_word(at, span, store, stack, buf, JUMP_STACK);
2486
2487        // Nothing is in a register past this point, which is what the rest of the function is
2488        // allowed to assume about the way back in.
2489        let gone = self.across_jump();
2490        let mut build = self.out.build(at, nothing).at(span);
2491        for (reg, class) in gone {
2492            build = build.operand(mir::Operand::write(reg, class));
2493        }
2494        build.finish();
2495
2496        // And the rest of the block, which is the block the address above was of.
2497        *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
2498        self.at = Some(back);
2499        let reg = self.new_reg(result);
2500        let mem = self.frame_mem();
2501        let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
2502        self.stack.addresses.push((made, answer));
2503        Ok(())
2504    }
2505
2506    /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
2507    ///
2508    /// Everything comes out of the buffer before anything is put back, and the four registers it
2509    /// comes out into are physical ones rather than values the allocator places. Both of those are
2510    /// about the same moment. The stack pointer is one of the things being put back, a value the
2511    /// allocator sent to the stack is reached through the stack pointer, and between the
2512    /// instruction that moves it and the jump there is no stack this function owns any more. A
2513    /// register named outright is a register nothing reloads into and nothing else is in, which is
2514    /// the only way to hold something across that moment.
2515    ///
2516    /// Four of them because that is how many things are in the air at once: where to go, the frame
2517    /// pointer to put back, the one the matching save is to answer with, and one register used
2518    /// twice, first for the address that one is written through and then for the stack pointer.
2519    ///
2520    /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
2521    /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
2522    /// written out and never run.
2523    fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
2524        let data = &self.source[inst];
2525        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2526        let span = self.source.span(inst);
2527        let buf = self.reg_of(buffer)?;
2528        let at = self.at.expect("a block is being filled");
2529        let gpr = self.gpr;
2530        let moves = x86_64::FRAME.moves(gpr).expect("a class the target says how to move");
2531        let load = self.named(moves.load);
2532        let store = self.named(moves.store);
2533        let mov = self.named(moves.mov);
2534        let put = self.named(x86_64::FRAME.imm);
2535        let jump = self.named(x86_64::BRANCH.indirect);
2536
2537        let held = self.jump_regs();
2538        if held.len() < JUMP_REGS {
2539            return Err(self.unsupported(inst));
2540        }
2541        let pc = mir::Reg::physical(held[0]);
2542        let frame = mir::Reg::physical(held[1]);
2543        let spare = mir::Reg::physical(held[2]);
2544        let one = mir::Reg::physical(held[3]);
2545
2546        self.read_word(at, span, load, pc, buf, JUMP_PC);
2547        self.read_word(at, span, load, frame, buf, JUMP_FRAME);
2548        self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
2549
2550        // What the matching save answers with, written through the address that came out of the
2551        // buffer, because the word it goes in is in the other function's frame and this one has no
2552        // way of knowing where that is.
2553        self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
2554        let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
2555        self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
2556
2557        // The stack last of the four, so that the register the buffer is reached through is done
2558        // with before the stack it may have been spilled to stops being this function's.
2559        self.read_word(at, span, load, spare, buf, JUMP_STACK);
2560        let stack = mir::Reg::physical(self.conv.stack_pointer);
2561        self.copy(at, span, mov, stack, spare);
2562        let base = mir::Reg::physical(self.conv.frame_pointer);
2563        self.copy(at, span, mov, base, frame);
2564
2565        // And the jump, which reads the two registers just put back as well as the address it
2566        // goes through. Neither of those is printed, because the target's spelling of an indirect
2567        // jump has one argument and it is the first one read. They are there because the code
2568        // control arrives at reaches its frame through them, and because without them the two
2569        // instructions above write registers nothing reads: a scheduler is then free to put the
2570        // jump in front of them, and at `-O2` it does.
2571        self.out
2572            .build(at, jump)
2573            .at(span)
2574            .operand(mir::Operand::read(pc, gpr))
2575            .operand(mir::Operand::read(stack, gpr))
2576            .operand(mir::Operand::read(base, gpr))
2577            .finish();
2578        Ok(())
2579    }
2580
2581    /// One word of the buffer of a `__builtin_setjmp`, written from a register.
2582    fn write_word(
2583        &mut self,
2584        at: mir::Block,
2585        span: Span,
2586        store: mir::Opcode,
2587        from: mir::Reg,
2588        buf: mir::Reg,
2589        word: i32,
2590    ) {
2591        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
2592        self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
2593    }
2594
2595    /// One word of that buffer, read back into a register.
2596    fn read_word(
2597        &mut self,
2598        at: mir::Block,
2599        span: Span,
2600        load: mir::Opcode,
2601        into: mir::Reg,
2602        buf: mir::Reg,
2603        word: i32,
2604    ) {
2605        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
2606        self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
2607    }
2608
2609    /// One register into another, which is the one shape of instruction the builder has no word
2610    /// for because neither operand is a definition of a value or a read of memory.
2611    fn copy(
2612        &mut self,
2613        at: mir::Block,
2614        span: Span,
2615        mov: mir::Opcode,
2616        into: mir::Reg,
2617        from: mir::Reg,
2618    ) {
2619        self.out
2620            .build(at, mov)
2621            .at(span)
2622            .operand(mir::Operand::write(into, self.gpr))
2623            .operand(mir::Operand::read(from, self.gpr))
2624            .finish();
2625    }
2626
2627    /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
2628    fn answer_slot(&mut self) -> usize {
2629        match self.answer {
2630            Some(index) => index,
2631            None => {
2632                let index = self.stack.locals.len();
2633                self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
2634                self.answer = Some(index);
2635                index
2636            }
2637        }
2638    }
2639
2640    /// An address in this function's frame with nothing in its displacement, which is what an
2641    /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
2642    /// where the object is.
2643    fn frame_mem(&self) -> mir::Mem {
2644        mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
2645    }
2646
2647    /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
2648    ///
2649    /// Both files, since a `double` live across a save has the same problem an integer does. The
2650    /// two registers a frame is reached through are not here: the restore puts both of them back,
2651    /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
2652    /// by its own save would have nothing left to find its caller with.
2653    fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
2654        let mut gone = Vec::new();
2655        for &reg in self.conv.int_order {
2656            if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
2657                continue;
2658            }
2659            gone.push((mir::Reg::physical(reg), self.gpr));
2660        }
2661        for &reg in self.conv.sse_order {
2662            gone.push((mir::Reg::physical(reg), self.conv.sse_class));
2663        }
2664        gone
2665    }
2666
2667    /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
2668    ///
2669    /// The ones the allocator hands out, less the two a frame is reached through. The scratch
2670    /// registers are not among them on purpose: the rewriter writes a reload into one of those
2671    /// wherever it likes, and one of these has to survive from the load that fills it to the
2672    /// instruction that reads it however many instructions apart those are.
2673    fn jump_regs(&self) -> Vec<PhysReg> {
2674        self.conv
2675            .int_order
2676            .iter()
2677            .copied()
2678            .filter(|&reg| {
2679                reg != self.conv.stack_pointer
2680                    && reg != self.conv.frame_pointer
2681                    && !crate::pipeline::SCRATCH.contains(&reg)
2682            })
2683            .collect()
2684    }
2685
2686    /// A machine opcode of this target from the name the target gives it.
2687    fn named(&mut self, name: &str) -> mir::Opcode {
2688        mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")))
2689    }
2690
2691    /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
2692    /// saved frame pointers and then one thing read at the end of it.
2693    ///
2694    /// Every frame that kept a frame pointer holds the caller's at the address the register points
2695    /// at, and the address that frame returns to one word above that, which is where the call
2696    /// instruction put it and where the prologue's push left it. So the walk is a load through the
2697    /// register for each link, the frame address is wherever the walk stopped, and the return
2698    /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
2699    /// x86-64 at `-O2` for depths zero to three of both builtins.
2700    ///
2701    /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
2702    /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
2703    /// needs it as the start, so there is no case here where it is not wanted.
2704    ///
2705    /// How far the chain actually reaches is the program's business and not this one's. A caller
2706    /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
2707    /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
2708    /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
2709    /// `check/builtin/frame.rs` rather than walked as far as it says.
2710    fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
2711        let data = &self.source[inst];
2712        let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
2713        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2714        let returning = data.opcode == Opcode::ReturnAddress;
2715        let block = self.at.expect("a block is being filled");
2716        let span = self.source.span(inst);
2717        let moves = x86_64::FRAME.moves(self.gpr).expect("a class the target says how to move");
2718        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", moves.load)));
2719        self.stack.walks_frames = true;
2720
2721        // Where the walk is up to. The frame pointer to begin with, and the register the last load
2722        // wrote after that.
2723        let reg = self.new_reg(result);
2724        let mut base = mir::Reg::physical(self.conv.frame_pointer);
2725        for link in 0..depth {
2726            // The last load of a walk that is looking for a frame writes the answer itself, which
2727            // is what keeps a walk of so many links that many instructions and not one more.
2728            let ends_here = link + 1 == depth && !returning;
2729            let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
2730            let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
2731            self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
2732            base = next;
2733        }
2734
2735        if returning {
2736            let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
2737            let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
2738            self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
2739        } else if depth == 0 {
2740            // The one case with no load in it at all: the frame this function is running in is the
2741            // register itself, and a physical register is not one the allocator hands out, so the
2742            // answer is a copy of it.
2743            let mov = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", moves.mov)));
2744            self.out
2745                .build(block, mov)
2746                .at(span)
2747                .operand(mir::Operand::write(reg, self.gpr))
2748                .operand(mir::Operand::read(base, self.gpr))
2749                .finish();
2750        }
2751        Ok(())
2752    }
2753
2754    /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
2755    /// an offset to.
2756    ///
2757    /// The same one instruction, on its own this time and with nothing to add to it. A program
2758    /// writes this when what it wants is a number that is different in every thread and cheap to
2759    /// come by, rather than a variable of its own in the block, so there is no relocation here and
2760    /// no name for the link to resolve.
2761    fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
2762        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2763        let block = self.at.expect("a block is being filled");
2764        let span = self.source.span(inst);
2765        let reg = self.new_reg(result);
2766        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{GOT_LOAD}")));
2767        let at = mir::Mem::in_segment(Segment::Fs, 0);
2768        self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
2769        Ok(())
2770    }
2771
2772    /// What a named machine register holds, which is `register long x asm ("rbx");`.
2773    ///
2774    /// One move out of that register, with the register named as itself the way a register a
2775    /// template wrote is named, which is [`Self::itself`] and is the thing #1653 built. What it
2776    /// buys here is what it buys there: the register is part of the instruction the allocator
2777    /// sees, so it is a use the allocator will not have written over first, and the value goes
2778    /// into an ordinary one of its own that everything downstream reads.
2779    ///
2780    /// The whole sixty four bits are moved whatever the type is, because the register is that
2781    /// wide and a narrower type reads the low end of the copy, which is the same low end. A type
2782    /// wider than the register is refused, since there is no register holding it to read.
2783    ///
2784    /// A name the machine has not got is refused too, and is the only thing that can be wrong
2785    /// with the string: which register a name means is this machine's question and this is where
2786    /// the question is asked, at the same table `asm` asks about clobbers at. The sigil gcc
2787    /// allows in front of it is taken off here, because what the name is written with is syntax.
2788    fn register_value(&mut self, inst: Inst) -> Result<(), Unsupported> {
2789        let Extra::Symbol(symbol) = self.source[inst].extra else {
2790            return Err(self.unsupported(inst));
2791        };
2792        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2793        let ty = self.source[result].ty;
2794        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
2795        if bits > ADDRESS_BITS {
2796            return Err(self.unsupported(inst));
2797        }
2798        let spelled = self.names.resolve(symbol).to_owned();
2799        let named = x86_64::gpr_named(spelled.strip_prefix('%').unwrap_or(&spelled));
2800        let Some((held, _)) = named else {
2801            return Err(Unsupported::Register { inst, name: spelled });
2802        };
2803        let block = self.at.expect("a block is being filled");
2804        let span = self.source.span(inst);
2805        let mov = x86_64::FRAME.moves(self.gpr).expect("a class the target says how to move").mov;
2806        let mov = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{mov}")));
2807        let into = self.new_reg(result);
2808        self.out
2809            .build(block, mov)
2810            .at(span)
2811            .operand(mir::Operand::write(into, self.gpr))
2812            .operand(
2813                mir::Operand::read(mir::Reg::physical(held), self.gpr)
2814                    .with(Constraint::Fixed(held)),
2815            )
2816            .finish();
2817        Ok(())
2818    }
2819
2820    /// A conversion that converts nothing: the result is the operand under another type.
2821    ///
2822    /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
2823    /// an integer as wide as the machine addresses, so a cast between the two changes what the
2824    /// type system calls the value and changes nothing about the value, and the register holding
2825    /// it is the register that already held it. The front end never writes either of them at any
2826    /// other width, because it widens or narrows around the cast rather than through it, so the
2827    /// two widths disagreeing here means the IR came from somewhere else and is refused rather
2828    /// than guessed at.
2829    ///
2830    /// Reading the operand first is what materializes it when it is a constant, which is the case
2831    /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
2832    /// register before anything can call it an address.
2833    fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
2834        let data = &self.source[inst];
2835        let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
2836        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2837        if !self.is_address_width(self.source[arg].ty)
2838            || !self.is_address_width(self.source[result].ty)
2839        {
2840            return Err(self.unsupported(inst));
2841        }
2842        let reg = self.reg_of(arg)?;
2843        self.regs[result.index()] = Some(reg);
2844        Ok(())
2845    }
2846
2847    /// One barrier, which on this machine is one instruction at the strongest ordering and no
2848    /// instruction at all at every other one.
2849    ///
2850    /// x86-64 is total store order, so the only reordering the machine does is a store followed by
2851    /// a load of a different address, and the only ordering that forbids that is sequential
2852    /// consistency. An acquire, a release and an acquire release fence are therefore already true
2853    /// of every program running here, and what a program wanted from writing one is that the
2854    /// compiler not move memory accesses across it. The optimizer has finished by the time this
2855    /// runs and nothing below reorders one access past another, so the constraint is already
2856    /// discharged and there is nothing to write.
2857    ///
2858    /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
2859    /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
2860    /// on the stack is faster on most parts and is what some compilers write instead; it is also a
2861    /// write to memory the program did not ask for, and the plain barrier is the one that says what
2862    /// it means.
2863    ///
2864    /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
2865    /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
2866    /// nothing, so there is no equality to state, and what makes it the right answer is the memory
2867    /// model, which the rule language cannot talk about.
2868    fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
2869        let Extra::Order(order) = self.source[inst].extra else {
2870            return Err(self.unsupported(inst));
2871        };
2872        if order != MemOrder::SeqCst {
2873            return Ok(());
2874        }
2875        let block = self.at.expect("a block is being filled");
2876        let span = self.source.span(inst);
2877        let fence = mir::Opcode::new(self.names.intern("x64.mfence"));
2878        self.out.build(block, fence).at(span).finish();
2879        Ok(())
2880    }
2881
2882    /// The instruction a program stops on, which is one byte pair and no operands.
2883    ///
2884    /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
2885    /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
2886    /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
2887    /// caught by anything the program installed for an ordinary error, cannot be returned from,
2888    /// and leaves the address of the fault in the core file.
2889    ///
2890    /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
2891    /// library, and it works in the places this one is written most, which are a kernel and a
2892    /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
2893    fn trap(&mut self, inst: Inst) {
2894        let block = self.at.expect("a block is being filled");
2895        let span = self.source.span(inst);
2896        let stop = mir::Opcode::new(self.names.intern("x64.ud2"));
2897        self.out.build(block, stop).at(span).finish();
2898    }
2899
2900    /// One hint that an address is about to be used, which is one instruction and no promise.
2901    ///
2902    /// Four instructions on this machine and the locality picks between them, which is what the
2903    /// number means: how much of the data will still be wanted after the access. None of it wanted
2904    /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
2905    /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
2906    /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
2907    /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
2908    ///
2909    /// Whether the access will write is not read here, and that is this machine rather than an
2910    /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
2911    /// writes it only when the command line said the part has it. So a prefetch for a write is the
2912    /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
2913    /// `-mprfchw`, and the difference is carried in the IR for a target that can use it.
2914    ///
2915    /// The address goes in the addressing mode rather than in an operand, the way a store's does.
2916    /// It is built here as the plainest one there is, a register and nothing else, because what
2917    /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
2918    /// this instruction. An address the program computed is therefore one `lea` or one add in front
2919    /// of this, which is what it would have been for the load the hint is about anyway.
2920    fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
2921        let Extra::Prefetch(hint) = self.source[inst].extra else {
2922            return Err(self.unsupported(inst));
2923        };
2924        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
2925        let [address] = args[..] else { return Err(self.unsupported(inst)) };
2926        let name = match hint.locality {
2927            0 => "prefetch_nta",
2928            1 => "prefetch_t2",
2929            2 => "prefetch_t1",
2930            PrefetchHint::MOST => "prefetch_t0",
2931            // Nothing else exists. The checker reads a locality outside the range as zero and the
2932            // verifier refuses one that got here another way, so this is a hint that was built
2933            // rather than checked, and the safe answer for a hint is to write no instruction.
2934            _ => return Err(self.unsupported(inst)),
2935        };
2936        let base = self.reg_of(address)?;
2937        let block = self.at.expect("a block is being filled");
2938        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2939        self.out
2940            .build(block, opcode)
2941            .at(self.source.span(inst))
2942            .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
2943            .finish();
2944        Ok(())
2945    }
2946
2947    /// One compare and exchange, which is the instruction every other atomic on this machine is
2948    /// built out of.
2949    ///
2950    /// What the IR asks for is: read what is at an address, compare it against a value the program
2951    /// expected, put a second value there if the two were equal, and say both what was read and
2952    /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
2953    /// front of it is what makes the whole of it one step as far as every other processor is
2954    /// concerned.
2955    ///
2956    /// The ordering is not read here, and that is the memory model rather than an omission. A
2957    /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
2958    /// compare and exchange and a sequentially consistent one are the same instruction, and there
2959    /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
2960    /// same reason.
2961    ///
2962    /// The two values it produces are why this is written by name. The one the program compares
2963    /// against and the one it gets back are both `rax`, which the instruction reads and writes
2964    /// without being told, and the table says so with a fixed constraint at each end rather than
2965    /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
2966    /// flag read out by a `sete`, and it is a definition of the same instruction so that the
2967    /// allocator knows the two are live together and never gives the byte the register the answer
2968    /// is in.
2969    fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
2970        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
2971        let results: Vec<Value> = self.source[inst].results().collect();
2972        let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
2973        let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
2974
2975        // A value the machine can compare in one instruction, which is an integer or an address at
2976        // one of the four widths it has a compare and exchange for. Anything else is a type this
2977        // has no instruction for rather than a program that is wrong, and the front end refuses it
2978        // before ever getting here.
2979        let ty = self.source[old].ty;
2980        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
2981        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
2982            return Err(self.unsupported(inst));
2983        }
2984
2985        let base = self.reg_of(addr)?;
2986        let want = self.reg_of(expected)?;
2987        let put = self.reg_of(desired)?;
2988        let got = self.new_reg(old);
2989        let flag = self.new_reg(exchanged);
2990
2991        let name = format!("cmpxchg_{bits}");
2992        let form = x86_64::form(&name).ok_or_else(|| self.unsupported(inst))?;
2993        let block = self.at.expect("a block is being filled");
2994        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2995        let (span, flags) = (self.source.span(inst), self.carried(inst));
2996        let mut build = self.out.build(block, opcode).at(span).flags(flags);
2997        for (desc, reg) in form.operands().iter().zip([got, flag, want, put]) {
2998            let operand = mir::Operand {
2999                reg,
3000                class: desc.class,
3001                role: desc.role,
3002                constraint: desc.constraint,
3003            };
3004            build = build.operand(operand);
3005        }
3006        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3007        Ok(())
3008    }
3009
3010    /// One read modify write, for the three operations this machine does in a single instruction.
3011    ///
3012    /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
3013    /// say what was there before, and let nothing get between the three steps. The machine has
3014    /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
3015    /// found in the register the operand arrived in, which is why the value that comes back and the
3016    /// value that went in are one register here.
3017    ///
3018    /// A subtraction is the add over the negated operand, which is right at every width because the
3019    /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
3020    /// whatever the operands were. The negate is a separate instruction in front, over a register of
3021    /// its own, so that the value the program handed over is not the one written on: an operand may
3022    /// be live after this and a program that read it again would read the negation.
3023    ///
3024    /// The ordering is not read, for the reason the compare and exchange beside this does not read
3025    /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
3026    /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
3027    ///
3028    /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
3029    /// around a compare and exchange before anything here saw it. The two that do arrive are the
3030    /// ones on floating values, and they are refused: a compare and exchange of a float wants the
3031    /// value carried through an integer of the same width, and an eighty bit float has no such
3032    /// width. Neither family of builtins can write one yet either, so a program that reaches this
3033    /// refusal is a program that reached an unimplemented builtin first.
3034    fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
3035        let Extra::Rmw(op, _) = self.source[inst].extra else {
3036            return Err(self.unsupported(inst));
3037        };
3038        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3039        let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
3040        let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3041
3042        // A value the machine can exchange in one instruction, which is an integer at one of the
3043        // four widths it has these for. A pointer arrives as an address, so it is an integer by the
3044        // time it is here, and anything else is a type this has no instruction for.
3045        let ty = self.source[old].ty;
3046        if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3047            return Err(self.unsupported(inst));
3048        }
3049        let name = match op {
3050            RmwOp::Xchg => format!("xchg_{}", ty.bits()),
3051            RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
3052            _ => return Err(self.unsupported(inst)),
3053        };
3054
3055        let base = self.reg_of(addr)?;
3056        let mut put = self.reg_of(operand)?;
3057        let block = self.at.expect("a block is being filled");
3058        let span = self.source.span(inst);
3059        if op == RmwOp::Sub {
3060            let negated = self.out.new_vreg(self.gpr);
3061            let negate =
3062                mir::Opcode::new(self.names.intern(&format!("{PREFIX}neg_r_{}", ty.bits())));
3063            let form = x86_64::form(&format!("neg_r_{}", ty.bits()))
3064                .ok_or_else(|| self.unsupported(inst))?;
3065            let mut build = self.out.build(block, negate).at(span);
3066            for (desc, reg) in form.operands().iter().zip([negated, put]) {
3067                build = build.operand(mir::Operand {
3068                    reg,
3069                    class: desc.class,
3070                    role: desc.role,
3071                    constraint: desc.constraint,
3072                });
3073            }
3074            build.finish();
3075            put = negated;
3076        }
3077
3078        let got = self.new_reg(old);
3079        let form = x86_64::form(&name).ok_or_else(|| self.unsupported(inst))?;
3080        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
3081        let flags = self.carried(inst);
3082        let mut build = self.out.build(block, opcode).at(span).flags(flags);
3083        for (desc, reg) in form.operands().iter().zip([got, put]) {
3084            build = build.operand(mir::Operand {
3085                reg,
3086                class: desc.class,
3087                role: desc.role,
3088                constraint: desc.constraint,
3089            });
3090        }
3091        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3092        Ok(())
3093    }
3094
3095    /// One `asm` statement.
3096    ///
3097    /// An empty template is most of the inline assembly in a test suite, and it is not a corner
3098    /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
3099    /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
3100    /// years of bug reports about optimizers are full of them. What such a statement asks for is
3101    /// the barrier and the operand places, and no instructions at all.
3102    ///
3103    /// So the operands are the half that is always real: a constraint says where a value has to be,
3104    /// and where it has to be is still true when the template between them is empty.
3105    ///
3106    /// What the constraints ask for, on an empty template, is only ever that two operands share a
3107    /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
3108    /// no particular one, and any register at all answers it. A matching constraint is different,
3109    /// because it says the output the assembly leaves is the place the input arrived in, and with
3110    /// no instructions between them that is the input unchanged. So it is a rename and not a move:
3111    /// the value is already in a register and the result is that register.
3112    ///
3113    /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
3114    /// which for a template that writes nothing is whatever was in the register. That is a value
3115    /// the program is not entitled to, and this writes a zero rather than reading one, because the
3116    /// allocator has to be given a definition before a use whatever the program is entitled to.
3117    ///
3118    /// # A template with instructions in it
3119    ///
3120    /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
3121    /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
3122    /// instruction a program wrote is looked up in that description rather than copied through to
3123    /// an assembler that has one of its own. So nothing here assembles anything. What it does is
3124    /// put the statement's operands where the opcode holds them, and from there an `asm` statement
3125    /// is ordinary machine code: the allocator picks the registers, the listing and the object file
3126    /// are written from the same table as every other instruction, and a spill around one works
3127    /// because there is nothing left about it for a spill to get wrong.
3128    ///
3129    /// A register the template named in its own text is the one thing in there that is nobody's
3130    /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
3131    /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
3132    ///
3133    /// Two things are refused, both for one reason, which is that placing them by a guess gives a
3134    /// program that assembles into something other than what it says.
3135    ///
3136    /// An output the template writes more than once, which is one place with two definitions in it,
3137    /// and the machine IR between here and the allocator has one definition per register by
3138    /// construction. An output tied to an input and written once is not that: it is two registers
3139    /// the description ties together, which is what [`Place`] is about.
3140    ///
3141    /// An operand read where the opcode writes, or written where it reads. An output that has not
3142    /// been written yet is not a value, and an input the assembly writes over is a value something
3143    /// else may still be using.
3144    ///
3145    /// # A register the instruction uses without being told
3146    ///
3147    /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
3148    /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
3149    /// registers. The description holds every bit of that already, so what is left is to say which
3150    /// of the statement's operands is in each of those registers, and the constraint letter is the
3151    /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
3152    /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
3153    /// and has no choice about it.
3154    ///
3155    /// A register no letter named is one the statement put nothing in, and that is the usual case
3156    /// rather than an unusual one, since an instruction that answers four questions is written by
3157    /// programs that asked one. A write of one is the register being destroyed and gets a register
3158    /// of its own, which is what tells the allocator to keep everything else out of it. A read of
3159    /// one is a register the instruction looks at and the program never filled, which gets a zero
3160    /// for the reason [`Self::undefined`] gives.
3161    ///
3162    /// # The clobber list
3163    ///
3164    /// Read now, as the registers it names being written by every instruction of the template. By
3165    /// every one rather than by one of them, because the list says the assembly as a whole leaves
3166    /// them ruined and nothing here knows which line did it. Every entry has to be a register this
3167    /// machine has a name for or the statement is refused, since a name nobody read is a register
3168    /// nobody is keeping out of.
3169    ///
3170    /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
3171    /// says the assembly touches storage, which is already true of every `asm` this writes and is
3172    /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
3173    /// tracking already has that from the instructions the template was read into, since it takes
3174    /// every instruction it does not recognize as writing them and every instruction here is one
3175    /// this machine describes. `flags` is the name gcc's own register table gives the same thing on
3176    /// this machine, so a program writing it has written `cc` and is read that way: tcc's
3177    /// `tests/tcctest.c` lists both on one statement.
3178    ///
3179    /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
3180    /// by description, and a statement listing three of them as clobbers as well is saying the
3181    /// same thing twice, which the allocator would read as one register with two definitions.
3182    ///
3183    /// On a template with nothing in it the list is ignored, as it was before, since a template
3184    /// with no instructions ruins nothing whatever it said about what it ruins.
3185    fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
3186        let data = &self.source[inst];
3187        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
3188        let info = self.source[asm];
3189        if !self.source[info.targets].is_empty() {
3190            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
3191        }
3192        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3193
3194        let constraints = self.names.resolve(info.constraints).to_string();
3195        let results: Vec<Value> = data.results().collect();
3196        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
3197            .ok_or_else(refused)?;
3198        let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
3199
3200        // Read after the constraints and not before them, because a mnemonic whose suffix the
3201        // program left off is read at the width of the operands it names, and the operands are
3202        // what the constraints are a list of.
3203        let widths: Vec<Option<x86_64::Width>> = list
3204            .iter()
3205            .map(|operand| {
3206                let ty = self.source[operand.result.or(operand.value)?].ty;
3207                if !ty.is_scalar() {
3208                    return None;
3209                }
3210                x86_64::Width::of_bits(held_bits(ty))
3211            })
3212            .collect();
3213        // An operand in memory is an address the statement holds and an object the template names,
3214        // so the reader is told which ones those are and spells `%0` for one as the object.
3215        let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
3216        let template = self.names.resolve(info.template).to_string();
3217        let steps = if template.trim().is_empty() {
3218            Vec::new()
3219        } else {
3220            x86_64::read_in(&template, &widths, &memory)
3221                .ok_or(Unsupported::Assembly { inst, refused: Written::Template })?
3222        };
3223
3224        // Which operands the template writes, counted before anything is placed, because the answer
3225        // decides where each of the three below comes from and one instruction may name an operand
3226        // that a later one writes. Which of them any instruction puts in a register at all is
3227        // counted in the same walk, since an operand no instruction reaches that way is one nothing
3228        // has to put anywhere: a constant a template names only as the distance into an address is
3229        // written into the instruction, and a register holding a copy of it would be one nobody
3230        // reads. An operand the address is counted from is reached that way and is counted here for
3231        // that reason, because the walk below it is over the opcode's operands and an address is
3232        // not one of those.
3233        //
3234        // Whether any instruction reads an operand an instruction above it wrote is counted in the
3235        // same walk too. Such a template is one whose instructions have to be written in order with
3236        // each read taken from wherever the last write left the operand, which is what
3237        // [`Self::woven`] does, and so is one that writes an operand twice.
3238        let mut writes = vec![0usize; list.len()];
3239        let mut reads = vec![false; list.len()];
3240        let mut held = vec![false; list.len()];
3241        let mut after = false;
3242        for step in &steps {
3243            // A call out of the template writes every register the convention lets the callee
3244            // leave anything in, and an output pinned to one of those is written by it.
3245            if let x86_64::Step::Call { .. } = step {
3246                for index in self.lost(&list).into_iter().filter_map(|(_, _, index)| index) {
3247                    *writes.get_mut(index).ok_or_else(refused)? += 1;
3248                }
3249                continue;
3250            }
3251            let x86_64::Step::Line(line) = step else { continue };
3252            match line.at.and_then(|at| at.base) {
3253                Some(x86_64::Piece::Operand { index, .. }) => {
3254                    *held.get_mut(index).ok_or_else(refused)? = true;
3255                    after |= writes[index] > 0;
3256                }
3257                Some(x86_64::Piece::Reg { reg, .. }) => {
3258                    if let Some(index) = bound(&list, reg, Role::Use) {
3259                        *held.get_mut(index).ok_or_else(refused)? = true;
3260                        after |= writes[index] > 0;
3261                    }
3262                }
3263                _ => {}
3264            }
3265            let mut written = Vec::new();
3266            let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3267            // Which registers the instruction reaches, asked the same way it is asked again when
3268            // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
3269            // comes from the constraint letters rather than from the description.
3270            let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
3271            let (described, pieces) = match &lettered {
3272                Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3273                None => (form.operands(), line.operands.as_slice()),
3274            };
3275            for (desc, piece) in described.iter().zip(pieces) {
3276                // An operand the instruction reaches without its text saying so is the statement's
3277                // only when a constraint letter put something there. One that is nobody's writes
3278                // nothing of the program's, so it is counted nowhere and is dealt with where it is
3279                // placed.
3280                let index = match *piece {
3281                    x86_64::Piece::Operand { index, .. } => index,
3282                    x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
3283                        Some(index) => index,
3284                        None => continue,
3285                    },
3286                    x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
3287                        Some(index) => index,
3288                        None => continue,
3289                    },
3290                };
3291                *held.get_mut(index).ok_or_else(refused)? = true;
3292                if matches!(desc.role, Role::Def | Role::EarlyDef) {
3293                    written.push(index);
3294                } else {
3295                    *reads.get_mut(index).ok_or_else(refused)? = true;
3296                    after |= writes[index] > 0;
3297                }
3298            }
3299            for index in written {
3300                *writes.get_mut(index).ok_or_else(refused)? += 1;
3301            }
3302        }
3303        let woven = after
3304            || writes.iter().any(|&count| count > 1)
3305            || steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_)));
3306
3307        // Where every operand is. Worked out in full before the first instruction is written, since
3308        // reading a value may be what puts it in a register in the first place, and that has to
3309        // happen in front of the assembly rather than in the middle of it.
3310        let mut places: Vec<Place> = vec![Place::default(); list.len()];
3311        for (index, operand) in list.iter().copied().enumerate() {
3312            let Some(result) = operand.result else {
3313                // An input, or an output the assembly was handed the address of, and both are a
3314                // value that arrives in a register and is read out of it, unless no instruction of
3315                // the template reads it out of one.
3316                let value = operand.value.ok_or_else(refused)?;
3317                if held[index] {
3318                    places[index].read = Some(self.reg_of(value)?);
3319                }
3320                continue;
3321            };
3322            let ty = self.source[result].ty;
3323            if on_x87(ty) {
3324                return Err(refused());
3325            }
3326            let tied = operands.tied_to(index);
3327            if let Some(from) = tied {
3328                if self.class_of(self.source[from].ty) != self.class_of(ty) {
3329                    return Err(refused());
3330                }
3331                places[index].read = Some(self.reg_of(from)?);
3332            }
3333            if writes[index] > 0 {
3334                places[index].write = Some(self.new_reg(result));
3335                continue;
3336            }
3337            match tied {
3338                // The place the input arrived in, which the assembly wrote nothing over. One
3339                // register, so this is a rename rather than a move.
3340                Some(_) => {
3341                    let reg = places[index].read.ok_or_else(refused)?;
3342                    self.regs[result.index()] = Some(reg);
3343                    places[index].write = Some(reg);
3344                }
3345                None => {
3346                    self.undefined(inst, result)?;
3347                    places[index].write = self.regs[result.index()];
3348                }
3349            }
3350        }
3351
3352        // An output an instruction of the template also reads, which the statement said nothing
3353        // about because an output is what a statement says the other thing about. What it holds
3354        // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
3355        // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
3356        // than for the number, so whatever the register held, the answer is the same. Undefined is
3357        // not the same as absent though, since the allocator is owed a definition in front of every
3358        // use, so it gets the zero an output nothing wrote gets and for the same reason.
3359        //
3360        // Unless an input could have been in the same register, in which case gcc's allocator puts
3361        // it there whenever it can and a program may have been written against that. tcc's test of
3362        // a call from a template reads its output `"=a" (s)` to pass `"r" (str)` to `getenv`, which
3363        // is only the string because gcc gave the two of them `rax`. So an output nothing has
3364        // written yet reads the one input that could share its place, when there is exactly one.
3365        // One written `&` is written before the inputs are read and shares nothing.
3366        for index in 0..list.len() {
3367            if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
3368                continue;
3369            }
3370            let reg = match self.shared(&list, index) {
3371                Some(value) => self.reg_of(value)?,
3372                None => self.seeded(inst, list[index])?,
3373            };
3374            places[index].read = Some(reg);
3375        }
3376
3377        // Worked out once for the whole template, since the list is one list and every instruction
3378        // of the template gets it. Not worked out at all for a template with no instructions, which
3379        // is where there is nothing for it to go on.
3380        let clobbers = self.names.resolve(info.clobbers).to_string();
3381        let clobbered =
3382            if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
3383
3384        // A template with a label in it is not one run of instructions, and what it is instead is
3385        // in [`Self::woven`], which is also where a template goes whose instructions read what the
3386        // ones above them wrote. Every other template is what it has always been, which is every
3387        // instruction of it written into the block the statement stands in.
3388        if woven {
3389            return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
3390        }
3391        for step in &steps {
3392            let x86_64::Step::Line(line) = step else { continue };
3393            self.instruction(inst, line, &places, &list, &clobbered)?;
3394        }
3395        Ok(())
3396    }
3397
3398    /// A register holding a zero, for an operand of a template that is read before anything filled
3399    /// it.
3400    ///
3401    /// Two things ask for this and they are the same thing twice. An output the template reads has
3402    /// nothing to be read out of until the instruction that writes it has run, and a loop carries
3403    /// an operand into a block before the instruction that fills it, so both are a use in front of
3404    /// every definition. What the program is owed there is nothing, since the value is undefined
3405    /// either way, and what the allocator is owed is a register something wrote.
3406    fn seeded(&mut self, inst: Inst, operand: AsmOperand<'_>) -> Result<mir::Reg, Unsupported> {
3407        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3408        let value = operand.result.or(operand.value).ok_or_else(refused)?;
3409        let class = self.class_of(self.source[value].ty);
3410        if class != self.gpr {
3411            return Err(refused());
3412        }
3413        let block = self.at.expect("a block is being filled");
3414        let reg = self.out.new_vreg(class);
3415        let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_64")));
3416        self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
3417        Ok(reg)
3418    }
3419
3420    /// A template with labels in it, as the blocks its jumps leave and arrive at.
3421    ///
3422    /// A statement is an instruction of the IR and stands inside one block, so a template that
3423    /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
3424    /// stands in and gives it two arms, and whatever follows the statement goes into whichever
3425    /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
3426    /// what [`Self::saves_place`] already does for the same reason.
3427    ///
3428    /// # What is carried between them
3429    ///
3430    /// The machine IR here is in the form where a register is written once, so an operand written
3431    /// inside a loop and read again at the top of it cannot be one register. What arrives at the
3432    /// top is a parameter of that block, and every jump to it carries whichever register held the
3433    /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
3434    /// made takes one parameter for each operand that is in a register at all, in one order, so an
3435    /// arm's arguments and a block's parameters are the same list read twice.
3436    ///
3437    /// Which register an operand is in at each point is kept in the read half of its place, since
3438    /// that is what the instructions below read it out of. An instruction that writes an operand
3439    /// leaves it in the register it wrote, and a jump below carries that one. The block an
3440    /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
3441    /// about where the operands are changes there.
3442    ///
3443    /// An operand written by the template and filled by nothing is written as a zero first, for
3444    /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
3445    /// instruction that fills it has run, and an argument has to be a register something wrote.
3446    ///
3447    /// # The condition state
3448    ///
3449    /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
3450    /// it are both written here, next to each other in one block, and what the allocator may put
3451    /// between them is a move, which on this machine leaves the condition state alone. The edge
3452    /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
3453    /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
3454    fn woven(
3455        &mut self,
3456        inst: Inst,
3457        steps: &[x86_64::Step],
3458        places: &mut [Place],
3459        list: &[AsmOperand<'_>],
3460        clobbered: &[PhysReg],
3461        writes: &[usize],
3462    ) -> Result<(), Unsupported> {
3463        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3464        let span = self.source.span(inst);
3465
3466        // Which operands are carried, which is every one that is in a register at all. An operand
3467        // the template never puts in one, such as a constant it names only as the distance into an
3468        // address, is in the instruction and has nowhere to be carried from.
3469        let mut carried: Vec<(usize, RegClass)> = Vec::new();
3470        for (index, operand) in list.iter().enumerate() {
3471            if places[index].read.is_none() && places[index].write.is_none() {
3472                continue;
3473            }
3474            let value = operand.result.or(operand.value).ok_or_else(refused)?;
3475            let ty = self.source[value].ty;
3476            if on_x87(ty) {
3477                return Err(refused());
3478            }
3479            carried.push((index, self.class_of(ty)));
3480        }
3481
3482        // What each of them holds where the template starts.
3483        for &(index, _) in &carried {
3484            if places[index].read.is_some() {
3485                continue;
3486            }
3487            if writes[index] == 0 {
3488                places[index].read = places[index].write;
3489                continue;
3490            }
3491            places[index].read = Some(self.seeded(inst, list[index])?);
3492        }
3493
3494        // The blocks, made before the walk because a jump forwards names a label the walk has not
3495        // reached yet.
3496        let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
3497        for step in steps {
3498            let x86_64::Step::Label(name) = step else { continue };
3499            let block = self.out.create_block();
3500            let mut params = Vec::with_capacity(carried.len());
3501            for &(_, class) in &carried {
3502                params.push(self.out.append_param(block, class));
3503            }
3504            labels.push((name.as_str(), block, params));
3505        }
3506
3507        let mut wrote: Vec<usize> = Vec::new();
3508        for step in steps {
3509            match step {
3510                x86_64::Step::Label(name) => {
3511                    let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
3512                    let from = self.at.expect("a block is being filled");
3513                    let args = Self::held(places, &carried).ok_or_else(refused)?;
3514                    *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
3515                    self.at = Some(block);
3516                    for (at, &(index, _)) in carried.iter().enumerate() {
3517                        places[index].read = params.get(at).copied();
3518                    }
3519                }
3520                x86_64::Step::Jump { opcode, to } => {
3521                    let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
3522                    let from = self.at.expect("a block is being filled");
3523                    let args = Self::held(places, &carried).ok_or_else(refused)?;
3524                    let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{opcode}")));
3525                    self.out.build(from, opcode).at(span).finish();
3526                    let next = self.out.create_block();
3527                    *self.out.succs_mut(from) =
3528                        vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
3529                    self.at = Some(next);
3530                }
3531                x86_64::Step::Away { symbol } => {
3532                    // Only in a function that is written without a prologue, which is the one
3533                    // place the jump means what it says. Anywhere else there is an epilogue behind
3534                    // the statement that puts the registers back and gives the frame up, and a
3535                    // jump over it goes to the next function with this function's frame still
3536                    // taken. The reader already made sure it is the last step of the template, so
3537                    // what is left to ask is about the function around it.
3538                    if !self.source.attrs.set.contains(AttrSet::NAKED) {
3539                        return Err(Unsupported::Assembly { inst, refused: Written::Away });
3540                    }
3541                    let from = self.at.expect("a block is being filled");
3542                    let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{AWAY}")));
3543                    let symbol = self.names.intern(symbol);
3544                    self.out.build(from, opcode).at(span).symbol(symbol).finish();
3545                    // Nowhere, which is what a jump out of the function leaves behind it and is
3546                    // the same list a `ret` leaves. The block after it is made for the walk above
3547                    // rather than for the program: the statement may be in the middle of a body
3548                    // that goes on being lowered, and what that lowering writes is reached by
3549                    // nothing and thrown away with the block.
3550                    *self.out.succs_mut(from) = Vec::new();
3551                    self.at = Some(self.out.create_block());
3552                }
3553                x86_64::Step::Call { symbol } => {
3554                    self.call_out(inst, symbol, places, list, clobbered, &carried, &mut wrote)?;
3555                }
3556                x86_64::Step::Line(line) => {
3557                    let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3558                    let mut written = Vec::new();
3559                    for (desc, piece) in form.operands().iter().zip(&line.operands) {
3560                        if !desc.role.is_def() {
3561                            continue;
3562                        }
3563                        let index = match *piece {
3564                            x86_64::Piece::Operand { index, .. } => index,
3565                            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
3566                                Some(index) => index,
3567                                None => continue,
3568                            },
3569                            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
3570                                Some(index) => index,
3571                                None => continue,
3572                            },
3573                        };
3574                        written.push(index);
3575                    }
3576                    // A register is written once in this form of the machine IR, so an operand
3577                    // an instruction above already wrote is written into a new one here, and what
3578                    // reads it below reads that one.
3579                    for &index in &written {
3580                        if !wrote.contains(&index) {
3581                            wrote.push(index);
3582                            continue;
3583                        }
3584                        let &(_, class) =
3585                            carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
3586                        let place = places.get_mut(index).ok_or_else(refused)?;
3587                        place.write = Some(self.out.new_vreg(class));
3588                    }
3589                    self.instruction(inst, line, places, list, clobbered)?;
3590                    for index in written {
3591                        let place = places.get_mut(index).ok_or_else(refused)?;
3592                        if place.write.is_some() {
3593                            place.read = place.write;
3594                        }
3595                    }
3596                }
3597            }
3598        }
3599
3600        // Where the walk left each output, which is the parameter of the block a label made when
3601        // the template ends in one and the register an instruction wrote when it does not.
3602        for (index, operand) in list.iter().enumerate() {
3603            let Some(result) = operand.result else { continue };
3604            if let Some(reg) = places[index].read {
3605                self.regs[result.index()] = Some(reg);
3606            }
3607        }
3608        Ok(())
3609    }
3610
3611    /// A template's call to a function somewhere else, as the call the convention makes.
3612    ///
3613    /// The opcode is the one a call written in C becomes, so everything that asks whether a
3614    /// function calls anything gets the answer it would for one: the stack pointer is left aligned
3615    /// at the statement and nothing is kept in the red zone. What is not the same is the operands.
3616    /// Nothing is passed by the convention, since the template put the arguments where it wanted
3617    /// them, and what comes back is whatever an output is pinned to, since that is the only thing
3618    /// the template says about it. Every other register the callee may leave anything in is
3619    /// written here, which is what a program that calls from a template never says and always
3620    /// means.
3621    #[allow(clippy::too_many_arguments)]
3622    fn call_out(
3623        &mut self,
3624        inst: Inst,
3625        symbol: &str,
3626        places: &mut [Place],
3627        list: &[AsmOperand<'_>],
3628        clobbered: &[PhysReg],
3629        carried: &[(usize, RegClass)],
3630        wrote: &mut Vec<usize>,
3631    ) -> Result<(), Unsupported> {
3632        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3633        let mut operands = Vec::new();
3634        let mut written = Vec::new();
3635        let lost = self.lost(list);
3636        for &(reg, class, index) in &lost {
3637            let Some(index) = index else {
3638                operands.push(mir::Operand::write(mir::Reg::physical(reg), class));
3639                continue;
3640            };
3641            // Written once in this form of the machine IR, so a second write is a new register,
3642            // the same as for an instruction in [`Self::woven`].
3643            if wrote.contains(&index) {
3644                let &(_, class) =
3645                    carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
3646                places.get_mut(index).ok_or_else(refused)?.write = Some(self.out.new_vreg(class));
3647            } else {
3648                wrote.push(index);
3649            }
3650            let place = places.get(index).ok_or_else(refused)?.write.ok_or_else(refused)?;
3651            operands.push(mir::Operand::write(place, class).with(Constraint::Fixed(reg)));
3652            written.push(index);
3653        }
3654        for &reg in clobbered {
3655            if lost.iter().all(|&(gone, class, _)| gone != reg || class != self.gpr) {
3656                operands.push(mir::Operand::write(mir::Reg::physical(reg), self.gpr));
3657            }
3658        }
3659        let block = self.at.expect("a block is being filled");
3660        let span = self.source.span(inst);
3661        let opcode = mir::Opcode::new(self.names.intern(abi::CALL));
3662        let symbol = self.names.intern(symbol);
3663        let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
3664        for operand in operands {
3665            build = build.operand(operand);
3666        }
3667        build.finish();
3668        let calls = &mut self.stack.calls;
3669        *calls = Some(calls.unwrap_or(0));
3670        for index in written {
3671            let place = places.get_mut(index).ok_or_else(refused)?;
3672            place.read = place.write;
3673        }
3674        Ok(())
3675    }
3676
3677    /// Every register a call may leave anything in, with its file and the output pinned to it if
3678    /// one is.
3679    ///
3680    /// Only a general purpose register is ever pinned to an output, since those are the only ones a
3681    /// constraint letter or a register variable names here. The vector registers are numbered from
3682    /// nought as well, so asking about one of them would find the output pinned to the register of
3683    /// the same number in the other file.
3684    fn lost(&self, list: &[AsmOperand<'_>]) -> Vec<(PhysReg, RegClass, Option<usize>)> {
3685        let conv = self.conv;
3686        let ints = conv.int_order.iter().filter(|&&reg| !conv.preserves_int(reg));
3687        let sses = conv.sse_order.iter().filter(|&&reg| !conv.preserves_sse(reg));
3688        ints.map(|&reg| (reg, conv.int_class, bound(list, reg, Role::Def)))
3689            .chain(sses.map(|&reg| (reg, conv.sse_class, None)))
3690            .collect()
3691    }
3692
3693    /// The input an output read before anything wrote it shares its register with, which is the
3694    /// one input that could be in that register, or nothing when there is none or more than one.
3695    ///
3696    /// Could be means nothing ties it elsewhere: it is in a register rather than in memory, no
3697    /// constraint pins it anywhere the output is not, and it is not tied to another output. An
3698    /// output written `&` shares nothing, since the assembly writes it before it reads the inputs.
3699    fn shared(&self, list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
3700        let output = list.get(index)?;
3701        if output.early || output.tied.is_some() {
3702            return None;
3703        }
3704        let class = self.class_of(self.source[output.result?].ty);
3705        let mut fits = list.iter().filter(|operand| {
3706            operand.result.is_none()
3707                && !operand.memory
3708                && operand.tied.is_none()
3709                && operand.value.is_some_and(|value| self.class_of(self.source[value].ty) == class)
3710                && pinned(operand).is_none_or(|reg| pinned(output) == Some(reg))
3711        });
3712        let value = fits.next()?.value;
3713        if fits.next().is_some() {
3714            return None;
3715        }
3716        value
3717    }
3718
3719    /// The block one of the template's labels made, and the parameters it takes.
3720    fn went<'b>(
3721        labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
3722        name: &str,
3723    ) -> Option<(mir::Block, &'b [mir::Reg])> {
3724        labels
3725            .iter()
3726            .find(|(had, ..)| *had == name)
3727            .map(|(_, block, params)| (*block, params.as_slice()))
3728    }
3729
3730    /// The register each carried operand is in, which is what an arm to a label carries.
3731    fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
3732        carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
3733    }
3734
3735    /// The registers a clobber list names, in the order it named them.
3736    ///
3737    /// Nothing is dropped. A name this has no register for is refused, because the list is the
3738    /// program telling the compiler which registers it may not leave anything in, and an entry
3739    /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
3740    /// two entries that are not registers and for why they are skipped rather than refused.
3741    fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
3742        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
3743        let mut named = Vec::new();
3744        for entry in clobbers.split(',') {
3745            let entry = entry.trim().trim_matches('"');
3746            // The sigil is optional in a clobber list and means nothing when it is there, unlike
3747            // in a template, where it is what tells a register from an operand.
3748            let entry = entry.strip_prefix('%').unwrap_or(entry);
3749            if entry.is_empty() || matches!(entry, "memory" | "cc" | "flags") {
3750                continue;
3751            }
3752            let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
3753            if !named.contains(&reg) {
3754                named.push(reg);
3755            }
3756        }
3757        Ok(named)
3758    }
3759
3760    /// One instruction of a template, as the machine instruction it was read back into.
3761    fn instruction(
3762        &mut self,
3763        inst: Inst,
3764        line: &x86_64::Line,
3765        places: &[Place],
3766        list: &[AsmOperand<'_>],
3767        clobbered: &[PhysReg],
3768    ) -> Result<(), Unsupported> {
3769        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3770        let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3771        // What the instruction reaches and what is in each of them. The description answers the
3772        // first for every opcode but one, and the pieces the template was read into answer the
3773        // second. Bytes a program wrote out itself are the one, since nothing in a number is a
3774        // register anybody could read, so the constraint letters answer both. See
3775        // [`Self::lettered`].
3776        let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
3777        let (described, pieces) = match &lettered {
3778            Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3779            None => (form.operands(), line.operands.as_slice()),
3780        };
3781        let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
3782        for (desc, piece) in described.iter().zip(pieces) {
3783            built.push(self.placed(inst, *desc, *piece, places, list)?);
3784        }
3785        // The clobbers go in among the definitions rather than behind the reads, because an operand
3786        // vector in the machine IR is every definition and then every use and what counts them
3787        // reads that order rather than each operand's role.
3788        let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
3789        let mut added = 0usize;
3790        for &reg in clobbered {
3791            if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
3792                continue;
3793            }
3794            built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
3795            added += 1;
3796        }
3797        // A constraint tying one operand to another names it by its place in this vector, and the
3798        // clobbers were put in the middle of the vector, so everything behind them moved. The
3799        // description is written against an instruction with no clobbers in it and cannot know
3800        // that, which makes this the one place the two numberings have to be reconciled.
3801        for operand in &mut built {
3802            if let Constraint::Reuse(at) = operand.constraint {
3803                if usize::from(at) >= defs {
3804                    let moved = usize::from(at) + added;
3805                    operand.constraint =
3806                        Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
3807                }
3808            }
3809        }
3810        let at = match line.at {
3811            Some(at) => Some(self.addressed(inst, at, places, list)?),
3812            None => None,
3813        };
3814
3815        let block = self.at.expect("a block is being filled");
3816        let span = self.source.span(inst);
3817        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", line.opcode)));
3818        let mut build = self.out.build(block, opcode).at(span);
3819        for operand in built {
3820            build = build.operand(operand);
3821        }
3822        if let Some(value) = line.imm {
3823            build = build.imm(value);
3824        }
3825        if let Some(mem) = at {
3826            build = build.mem(mem);
3827        }
3828        build.finish();
3829        Ok(())
3830    }
3831
3832    /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
3833    /// description of an opcode.
3834    ///
3835    /// Every other instruction of a template has a description saying which registers it reaches
3836    /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
3837    /// wrote out itself have no such description and could not have one: what the instruction is, is
3838    /// a number, and nothing in a number is a register anything could read. So the letters are the
3839    /// whole of what is known, and they are enough, because a program writing an instruction this
3840    /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
3841    ///
3842    /// Each register named by a letter gets one entry for the write and one for the read, the same
3843    /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
3844    /// written here and one no input names is not read. The writes come first because that is the
3845    /// order an operand vector in the machine IR is counted in. A register named by nothing is left
3846    /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
3847    /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
3848    /// touch is known only from what the program said.
3849    fn lettered(&self, list: &[AsmOperand<'_>]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
3850        let mut named: Vec<PhysReg> = Vec::new();
3851        for operand in list {
3852            if let Some(reg) = pinned(operand) {
3853                if !named.contains(&reg) {
3854                    named.push(reg);
3855                }
3856            }
3857        }
3858        let mut described = Vec::with_capacity(named.len() * 2);
3859        let mut pieces = Vec::with_capacity(named.len() * 2);
3860        for role in [Role::Def, Role::Use] {
3861            for &reg in &named {
3862                if bound(list, reg, role).is_none() {
3863                    continue;
3864                }
3865                let desc = if role.is_def() {
3866                    OperandDesc::write(self.gpr)
3867                } else {
3868                    OperandDesc::read(self.gpr)
3869                };
3870                described.push(desc.with(Constraint::Fixed(reg)));
3871                pieces.push(x86_64::Piece::Implicit { reg });
3872            }
3873        }
3874        (described, pieces)
3875    }
3876
3877    /// One operand of one instruction of a template, in the register the statement put it in.
3878    fn placed(
3879        &mut self,
3880        inst: Inst,
3881        desc: OperandDesc,
3882        piece: x86_64::Piece,
3883        places: &[Place],
3884        list: &[AsmOperand<'_>],
3885    ) -> Result<mir::Operand, Unsupported> {
3886        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3887        // A register the instruction reaches without its text naming it belongs to whichever of the
3888        // statement's operands a constraint letter put there, and to nobody when no letter did.
3889        // There is no width to check in that case: the operand is the register the letter named and
3890        // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
3891        let (index, spelled) = match piece {
3892            x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
3893            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
3894                Some(index) => (index, None),
3895                None => return self.spare(inst, desc),
3896            },
3897            // A register the template named, which belongs to one of the statement's operands when
3898            // a constraint letter put that operand there and to nobody otherwise. Asked in that
3899            // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
3900            // the program saying one thing twice, and answering it twice would hand the allocator
3901            // one register holding two values.
3902            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
3903                Some(index) => (index, None),
3904                None => return self.itself(inst, desc, reg),
3905            },
3906        };
3907        let operand = list.get(index).copied().ok_or_else(refused)?;
3908        // The two halves of an operand written `+`, which arrives in one register and leaves in
3909        // another with the allocator told to make them the same one. Everything else has one of
3910        // the two and asking for the other is the refusal below.
3911        let place = places.get(index).copied().ok_or_else(refused)?;
3912        let reg = match desc.role {
3913            Role::Use => place.read,
3914            Role::Def | Role::EarlyDef => place.write,
3915        }
3916        .ok_or_else(refused)?;
3917
3918        // Read where the opcode reads and written where it writes, which is what the first half of
3919        // this asks. An output has a result and an input has a value, an output written `+` has
3920        // both because it is read before it is written, and an output a matching constraint names
3921        // is read as the input that named it. See [`read_as`].
3922        // An output with neither is read as well, and what it holds there is undefined, which
3923        // [`Self::assembly`] says why and puts a zero in a register for.
3924        let placeable = match desc.role {
3925            Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
3926            Role::Def | Role::EarlyDef => operand.result.is_some(),
3927        };
3928        let ty = match (operand.result, operand.value) {
3929            (Some(result), _) => self.source[result].ty,
3930            (None, Some(value)) => self.source[value].ty,
3931            (None, None) => return Err(refused()),
3932        };
3933        let bits = held_bits(ty);
3934        if !placeable || self.class_of(ty) != desc.class {
3935            return Err(refused());
3936        }
3937        if let Some((width, stated)) = spelled {
3938            // An operand the template wrote a width on may be written by an instruction that fills
3939            // more of the register than the object in it does, and the object is then the low part
3940            // of what was written. That is what gmp asks for when it counts the low zero bits of a
3941            // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
3942            // the whole register and the `unsigned` is the bottom of it, which is every bit of an
3943            // answer that cannot exceed sixty four anyway.
3944            //
3945            // An operand read at a width the template wrote is the other way round: the object is
3946            // in the register and the instruction looks at the bottom of it. tcc tests the low bits
3947            // of a `size_t` count with `testb $2,%b4`, and every bit that test reads is one the
3948            // object put there.
3949            //
3950            // A write of less of a register than the object fills is right in one case, which is
3951            // an instruction that reads the register it writes and an operand that arrives with
3952            // the object in it. The top of the register is then the top of the object, and the
3953            // instruction leaves it alone. tcc swaps the bytes of an `unsigned` with `xchgb
3954            // %b0,%h0` and a rotate between two of them, and the swap only ever touches the low
3955            // half.
3956            //
3957            // The two that stay refused are a read of more of a register than its type fills,
3958            // which hands an instruction bits nothing ever put there, and a write of less of one
3959            // that nothing carried the object into, which leaves the top of the object holding
3960            // whatever the register held before. An operand the template left plain is refused
3961            // either way, because what gets spelled for that one is the register at the width of
3962            // its type and no other instruction is the one written down.
3963            let carried = matches!(desc.constraint, Constraint::Reuse(_) | Constraint::Fixed(_))
3964                && read_as(list, index).is_some();
3965            // The other case is the one the machine settles by itself: a write of the low four
3966            // bytes of a register clears the four above them, so a sixty four bit object written
3967            // that way holds the thirty two bit answer and nothing else. tcc loads a word through
3968            // `movl 4(%0),%k0` into a `long` and means exactly that.
3969            let cleared = desc.class == self.gpr && width == x86_64::Width::Long && bits == 64;
3970            let widened = stated && desc.role.is_def() && width.bits() > bits;
3971            let narrowed =
3972                stated && width.bits() < bits && (!desc.role.is_def() || carried || cleared);
3973            if bits != width.bits() && !widened && !narrowed {
3974                return Err(refused());
3975            }
3976        }
3977        // An operand the program pinned is in that register and nowhere else, whatever the opcode
3978        // would have allowed it. That is the whole of what a local register variable asks for, and
3979        // it is the same shape a division already has: the allocator is told the register, puts a
3980        // move in front or behind where it has to, and leaves it out where it does not.
3981        let constraint = match pinned(&operand) {
3982            Some(reg) => Constraint::Fixed(reg),
3983            None => desc.constraint,
3984        };
3985        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint })
3986    }
3987
3988    /// A register the template named in its own text.
3989    ///
3990    /// Not one of the statement's operands and not something the allocator handed out. The program
3991    /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
3992    /// something the constraint letters cannot say is made of: micropython saves the callee-saved
3993    /// registers into a buffer by name because the whole point of the buffer is that those exact
3994    /// registers are in it, and there is no constraint letter for `%rsp`.
3995    ///
3996    /// So it is placed as itself, fixed to the register the template named. What that buys is the
3997    /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
3998    /// write of one is a definition it knows about and will not leave anything of the program's
3999    /// across, and a read of one is a use it will not have put something else in first. gcc copies
4000    /// the text out and a register two things believe they own is a wrong program nothing reports.
4001    /// Here the allocator is told, and a program that also named the register in its clobber list
4002    /// says the same thing twice rather than something new.
4003    fn itself(
4004        &mut self,
4005        inst: Inst,
4006        desc: OperandDesc,
4007        reg: PhysReg,
4008    ) -> Result<mir::Operand, Unsupported> {
4009        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
4010        if desc.class != self.gpr {
4011            return Err(refused);
4012        }
4013        Ok(mir::Operand {
4014            reg: mir::Reg::physical(reg),
4015            class: self.gpr,
4016            role: desc.role,
4017            constraint: Constraint::Fixed(reg),
4018        })
4019    }
4020
4021    /// A register an instruction of a template uses and the statement put nothing in.
4022    ///
4023    /// A write of one is the register being destroyed, which is what a clobber list is usually
4024    /// written to say and what an instruction with more answers than the program asked for does
4025    /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
4026    /// register of its own is the whole of what that needs, since a value nothing reads is one the
4027    /// allocator may put anywhere and is told about so that nothing else is put there.
4028    ///
4029    /// A read of one is a register the instruction looks at and the program never filled, which
4030    /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
4031    /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
4032    /// zero is the one answer that reads the same on every run.
4033    fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
4034        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
4035        if desc.class != self.gpr {
4036            return Err(refused);
4037        }
4038        let reg = self.out.new_vreg(desc.class);
4039        if !desc.role.is_def() {
4040            let block = self.at.expect("a block is being filled");
4041            let span = self.source.span(inst);
4042            let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_64")));
4043            self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
4044        }
4045        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
4046    }
4047
4048    /// The address one instruction of a template reads or writes.
4049    fn addressed(
4050        &mut self,
4051        inst: Inst,
4052        at: x86_64::At,
4053        places: &[Place],
4054        list: &[AsmOperand<'_>],
4055    ) -> Result<mir::Mem, Unsupported> {
4056        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4057        let base = match at.base {
4058            None => None,
4059            Some(x86_64::Piece::Operand { index, .. }) => {
4060                // The register an address is counted from is read and never written, whatever the
4061                // instruction does to what it finds there.
4062                let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
4063                Some(mir::Operand::read(reg, self.gpr))
4064            }
4065            // A register the template named, counted from as itself. See [`Self::itself`], and note
4066            // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
4067            // names one register as the thing being stored and another as where to store it. An
4068            // operand a constraint letter put in that register is that operand, for the reason
4069            // [`Self::placed`] gives.
4070            Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
4071                Some(index) => {
4072                    let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
4073                    Some(mir::Operand::read(reg, self.gpr))
4074                }
4075                None => Some(
4076                    mir::Operand::read(mir::Reg::physical(reg), self.gpr)
4077                        .with(Constraint::Fixed(reg)),
4078                ),
4079            },
4080            // An address counted from a register the instruction reaches without being told is
4081            // not something this machine has: every addressing mode is written out in the text it
4082            // is part of, so a base that got here another way is a base nothing wrote down.
4083            Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
4084        };
4085        // A distance the template wrote, or the one in an operand the template pointed at, which is
4086        // the same distance said by something that knows how big a thing is. It has to be a number
4087        // the compiler can read at translation time, since it goes in the instruction rather than
4088        // in a register, and an operand holding anything else is refused rather than put somewhere.
4089        let disp = match at.disp {
4090            x86_64::Disp::Number(disp) => disp,
4091            x86_64::Disp::Operand(index) => {
4092                let value =
4093                    list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
4094                let number = self.number(value).ok_or_else(refused)?;
4095                i32::try_from(number).map_err(|_| refused())?
4096            }
4097        };
4098        Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
4099    }
4100
4101    /// The number in that value, for one an `iconst` defined, read at the width of its own type.
4102    ///
4103    /// Signed, because the two things a template asks this for are a distance into an address and
4104    /// the number on an instruction, and both of those are signed wherever they land. A constant
4105    /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
4106    /// which is the same number and is the reading that fits in the thirty two bits an addressing
4107    /// mode has room for.
4108    fn number(&self, value: Value) -> Option<i128> {
4109        let Def::Result { inst, .. } = self.source[value].def else { return None };
4110        if self.source[inst].opcode != Opcode::IConst {
4111            return None;
4112        }
4113        let Extra::Imm(imm) = self.source[inst].extra else { return None };
4114        let bits = self.source[imm].bits();
4115        let width = self.source[value].ty.bits();
4116        if width == 0 || width > 128 {
4117            return None;
4118        }
4119        let spare = 128 - width;
4120        Some(((bits << spare) as i128) >> spare)
4121    }
4122
4123    /// A register holding a value the program has no claim on, written as a zero.
4124    ///
4125    /// Every other way of saying it costs the same instruction or needs a word the machine IR does
4126    /// not have, and a zero is the one that reads the same on every run.
4127    fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
4128        let ty = self.source[result].ty;
4129        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
4130        let bits = held_bits(ty);
4131        if self.class_of(ty) != self.gpr || !matches!(bits, 8 | 16 | 32 | 64) {
4132            return Err(refused);
4133        }
4134        let block = self.at.expect("a block is being filled");
4135        let span = self.source.span(inst);
4136        let reg = self.new_reg(result);
4137        let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_{bits}")));
4138        self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
4139        Ok(())
4140    }
4141
4142    /// Whether a type is the width an address is, which is what makes a cast to or from one free.
4143    fn is_address_width(&self, ty: Type) -> bool {
4144        ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
4145    }
4146
4147    /// Where a block goes, which in machine IR is on the block rather than on its terminator.
4148    ///
4149    /// That is why no rule ever names a block: a branch is selected for what it reads and the
4150    /// edges are copied across here, arguments and all. The arguments are read last, after every
4151    /// instruction of the block is written, because an argument that is a constant is
4152    /// materialized where it is first wanted and the end of the block is where an edge wants it.
4153    ///
4154    /// Which is not quite the end. A block that leaves two ways has the branch as its last
4155    /// instruction, and a block that leaves through a register has the indirect jump as its last,
4156    /// and anything appended after either is something it has already jumped past, so a constant
4157    /// materialized here would be a register the block below reads and nothing ever writes. The
4158    /// one that was there is put back on the end when that happened, which is the only reordering
4159    /// anything in this crate does and is why it is remembered before a single argument is read.
4160    fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
4161        let Some(term) = self.source.terminator(block) else { return Ok(()) };
4162        let leaves = matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr);
4163        let branch = if leaves { self.out.terminator(out) } else { None };
4164
4165        let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
4166        let mut succs = Vec::with_capacity(calls.len());
4167        for call in calls {
4168            let args: Vec<Value> = self.source[call.args].to_vec();
4169            let mut regs = Vec::with_capacity(args.len());
4170            for value in args {
4171                // The address of where the value is rather than the value, for the one type a
4172                // register holds none of. The block on the other side copies the bytes out of it
4173                // into a slot of its own, which is what makes a second edge into the same block
4174                // safe.
4175                let reg = if on_x87(self.source[value].ty) {
4176                    self.x87_slot(value)
4177                } else {
4178                    self.reg_of(value)?
4179                };
4180                regs.push(reg);
4181            }
4182            succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
4183        }
4184        if let Some(branch) = branch {
4185            if self.out.terminator(out) != Some(branch) {
4186                self.out.remove_inst(branch);
4187                self.out.append_inst(out, branch);
4188            }
4189        }
4190        *self.out.succs_mut(out) = succs;
4191        Ok(())
4192    }
4193
4194    /// The machine IR block an IR block became.
4195    fn out_block(&self, block: Block) -> mir::Block {
4196        self.blocks[block.index()].expect("every block was created before any was filled")
4197    }
4198
4199    /// The parameters of the entry block, which are the function's arguments.
4200    ///
4201    /// They are not block parameters in the machine IR and they cannot be. A block parameter is
4202    /// given its value by a move on the edge into the block, and there is no edge into an entry
4203    /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
4204    /// says it.
4205    ///
4206    /// The ones past the last register arrived in the caller's memory and are read out of it, and
4207    /// the loads that read them come back here so that the frame can finish them the way it
4208    /// finishes an `alloca`.
4209    fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
4210        let params = self.source[block].params.clone();
4211        // The type of each is the block's answer and what the ABI asks of it is the signature's,
4212        // and the two lists are the same list: a parameter the classification turned into a
4213        // pointer is a pointer in the block too. A block with more parameters than the signature
4214        // names is not one the front end writes, and each of those is taken as a plain value.
4215        let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
4216        let types: Vec<Param> = params
4217            .iter()
4218            .enumerate()
4219            .map(|(index, &value)| {
4220                let abi = asked.get(index).copied().unwrap_or_default();
4221                Param { ty: self.source[value].ty, abi }
4222            })
4223            .collect();
4224        // A save area for a function that takes arguments its signature does not name, which is a
4225        // block of this function's frame on one convention and the shadow space the caller already
4226        // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
4227        // [`Self::save_area`] is where the difference is spent.
4228        let variadic = self.source.signature().variadic;
4229        let area = variadic.then(|| varargs::Area::of(self.conv));
4230        let arrived = abi::entry(&mut self.out, out, &types, self.conv, self.names, area)
4231            .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
4232        for (&param, reg) in params.iter().zip(&arrived.regs) {
4233            self.regs[param.index()] = Some(*reg);
4234        }
4235        if let Some(area) = area {
4236            self.save_area(out, &arrived, area);
4237        }
4238        self.stack.arguments.extend(arrived.stack);
4239        Ok(())
4240    }
4241
4242    /// The prologue of a variadic function, which is every argument register it was handed written
4243    /// into the frame.
4244    ///
4245    /// Every one the signature did not name, that is. Which of those hold anything is a thing only
4246    /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
4247    /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
4248    /// ever reads their slots.
4249    ///
4250    /// What that costs is up to fourteen stores in the prologue of a function that may read none of
4251    /// them, and the convention's answer to that is the count of vector registers in `%al`, which
4252    /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
4253    /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
4254    /// has no blocks to branch between. So they are all written every time, which is correct and is
4255    /// what `-O0` costs. Issue #323 is the branch.
4256    ///
4257    /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
4258    /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
4259    /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
4260    ///
4261    /// The address is computed once into a register rather than written as a displacement off the
4262    /// stack pointer, because a displacement into a frame is not known until after allocation and
4263    /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
4264    /// gets and [`crate::finish`] fills it in the same way.
4265    ///
4266    /// A convention that homes its register arguments has none of that. Its area is the shadow
4267    /// space the caller reserved above the return address, so there is no object to make and no
4268    /// address to work out: each store reaches into the caller's argument area the way the load of
4269    /// a parameter the registers ran out before does, which is the same waiting list and the same
4270    /// fixup. There are at most four of them and none is a vector register, since a float the
4271    /// signature does not name arrived in a general purpose register too and that is the copy the
4272    /// walk reads.
4273    fn save_area(&mut self, out: mir::Block, arrived: &abi::Arrived, area: varargs::Area) {
4274        if self.conv.shared_positions {
4275            self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
4276            let store = mir::Opcode::new(self.names.intern("x64.mov_mr_64"));
4277            for &(reg, class, at) in &arrived.spare {
4278                let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
4279                let made =
4280                    self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
4281                self.stack.arguments.push((made, at));
4282            }
4283            return;
4284        }
4285
4286        let save = self.stack.locals.len();
4287        self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
4288        self.varargs = Some(Varargs::Fields {
4289            save,
4290            incoming: arrived.beyond,
4291            integers: u32::try_from(arrived.took.0).unwrap_or(0) * area.stride(false),
4292            floats: area.starts_at(true)
4293                + u32::try_from(arrived.took.1).unwrap_or(0) * area.stride(true),
4294        });
4295
4296        let base = self.frame_address(out, save);
4297        for &(reg, class, at) in &arrived.spare {
4298            let name = if class == self.gpr { "x64.mov_mr_64" } else { "x64.movaps_mr" };
4299            let store = mir::Opcode::new(self.names.intern(name));
4300            let up = i32::try_from(at).expect("a register save area under two gigabytes");
4301            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
4302            self.out.build(out, store).uses(reg, class).mem(mem).finish();
4303        }
4304    }
4305
4306    /// The address of one of the function's stack objects, in a fresh register.
4307    ///
4308    /// Written with nothing in its displacement, because where an object is in a frame is not known
4309    /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
4310    fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
4311        let reg = self.out.new_vreg(self.gpr);
4312        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
4313        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
4314        let made = self.out.build(out, lea).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
4315        self.stack.addresses.push((made, local));
4316        reg
4317    }
4318
4319    /// Whether an instruction is one no machine instruction is written for where it stands.
4320    ///
4321    /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
4322    /// written where a register for it is first wanted rather than where the IR put it, and every
4323    /// reader of one may have folded it into an immediate, in which case nowhere is the right
4324    /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
4325    /// and leaves, and it is appended to every block with no successors long after this has
4326    /// finished, so a return with a value is one instruction here and a return without one is
4327    /// none. Unless the value went back through memory, in which case there is something to put
4328    /// somewhere after all and the IR does not carry it: the address the caller handed over has
4329    /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
4330    ///
4331    /// An unconditional jump is the third, and there is even less of it: the edge is on the
4332    /// block, and whether the block it goes to is the next one and needs no jump at all is the
4333    /// block layout's answer rather than this one's.
4334    ///
4335    /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
4336    /// the `unreachable` terminator the front end puts at the end of a function whose body can run
4337    /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
4338    /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
4339    /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
4340    /// successors, so the epilogue lands at the end of it the way it does on any other block that
4341    /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
4342    /// the assembler puts next.
4343    fn writes_nothing(&self, inst: Inst) -> bool {
4344        let data = &self.source[inst];
4345        match data.opcode {
4346            Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
4347            Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
4348            _ => false,
4349        }
4350    }
4351
4352    /// What every instruction in one block matched, with a set of values nobody may take.
4353    ///
4354    /// Backwards, because an instruction that has been folded into a later one does not get to
4355    /// fold anything into itself: the rule that took it only reached one level down, so what is
4356    /// under it is not in the term the matcher saw and cannot be replaced.
4357    fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
4358        let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
4359        let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
4360        let mut folded: Vec<Inst> = Vec::new();
4361        for (index, &inst) in insts.iter().enumerate().rev() {
4362            if folded.contains(&inst) {
4363                continue;
4364            }
4365            if let Some((plan, matched)) = self.select(inst, refused) {
4366                folded.extend(self.folds(inst, plan));
4367                found[index] = Some(matched);
4368                plans[index] = Some(plan);
4369            }
4370        }
4371        Decided { found, plans, folded }
4372    }
4373
4374    /// A value some of its readers took and some of them did not, which is the one case folding
4375    /// buys nothing.
4376    ///
4377    /// Folding does not delete the instruction that computed a value for anybody else, so a
4378    /// reader that did not take it still needs it in a register and the instruction stays. The
4379    /// reader that did take it now does that work again. Either all of them take it, in which
4380    /// case nothing is left to read it and the instruction goes, or none of them do.
4381    ///
4382    /// The count is over the whole function rather than over the block, since a value read from
4383    /// another block is read from a register there whatever this block decides. An instruction
4384    /// built by name rather than matched, a call being the one that matters, has no plan and so
4385    /// takes nothing, which is the right answer for it as well.
4386    fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
4387        let mut taken = vec![0u32; self.uses.len()];
4388        for (&inst, plan) in insts.iter().zip(plans) {
4389            let Some(plan) = plan else { continue };
4390            let args = &self.source[self.source[inst].args];
4391            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
4392                if plan[index] == Shown::Expand {
4393                    taken[arg.index()] += 1;
4394                }
4395            }
4396        }
4397        for (&inst, plan) in insts.iter().zip(plans) {
4398            let Some(plan) = plan else { continue };
4399            let args = &self.source[self.source[inst].args];
4400            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
4401                if plan[index] == Shown::Expand && taken[arg.index()] < self.uses[arg.index()] {
4402                    return Some(arg);
4403                }
4404            }
4405        }
4406        None
4407    }
4408
4409    /// The rule that fires on an instruction, and what it bound.
4410    ///
4411    /// The plans are tried in order and the first that matches wins, which is the maximal munch
4412    /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
4413    /// that offers less.
4414    fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
4415        for plan in self.plans(inst, refused) {
4416            let terms = Terms::new(self.source, inst, plan);
4417            if let Some(matched) = TABLE.find(&terms, Term::Root) {
4418                return Some((plan, matched));
4419            }
4420        }
4421        None
4422    }
4423
4424    /// Every way this instruction can be shown to the matcher, most offered first.
4425    fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> Vec<Plan> {
4426        let args = &self.source[self.source[inst].args];
4427        let mut plans = vec![PLAIN];
4428        for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
4429            let mut ways = Vec::new();
4430            if self.foldable(inst, arg, refused) {
4431                ways.push(Shown::Expand);
4432            }
4433            if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
4434                ways.push(Shown::Const);
4435            }
4436            ways.push(Shown::Reg);
4437            plans = plans
4438                .into_iter()
4439                .flat_map(|plan| {
4440                    ways.iter().map(move |&way| {
4441                        let mut next = plan;
4442                        next[index] = way;
4443                        next
4444                    })
4445                })
4446                .collect();
4447        }
4448        plans
4449    }
4450
4451    /// Whether an operand may be shown as the instruction that computed it.
4452    ///
4453    /// It has to be in the same block, because a rule that folds one instruction into another
4454    /// moves the work to where the second one is. It has to be something rather than a block
4455    /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
4456    /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
4457    /// question is asked here: this says yes to a value with any number of readers, and a value
4458    /// only some of them could take is refused after the fact and asked again.
4459    ///
4460    /// A value with several readers used to be refused outright, on the reasoning that folding
4461    /// does not delete the instruction for anybody else. That reasoning is about the set of
4462    /// readers and was being applied to one reader at a time, which is stricter than it needs to
4463    /// be: when every reader takes it there is nobody left to read it and the instruction goes.
4464    /// An address a store and a load share is the shape that matters, since a memory operand has
4465    /// room for the whole of it and both readers have a memory operand.
4466    fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
4467        let Def::Result { inst, .. } = self.source[value].def else { return false };
4468        if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
4469            return false;
4470        }
4471        self.source.block_of(inst).is_some()
4472            && self.source.block_of(inst) == self.source.block_of(into)
4473    }
4474
4475    /// The instructions a match folded into the one it matched.
4476    ///
4477    /// The plan is what says this, not the bindings: a binding is a register or a number either
4478    /// way, and an operand shown as the instruction that computed it is one no rule could have
4479    /// matched without taking that instruction, because the plan offered the matcher nothing
4480    /// else to call it.
4481    fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
4482        let args = &self.source[self.source[inst].args];
4483        args.iter()
4484            .take(MAX_ARGS)
4485            .enumerate()
4486            .filter(|&(index, _)| plan[index] == Shown::Expand)
4487            .filter_map(|(_, &arg)| match self.source[arg].def {
4488                Def::Result { inst, .. } => Some(inst),
4489                Def::Param { .. } => None,
4490            })
4491            .collect()
4492    }
4493
4494    /// What the IR instruction said about itself that the machine instruction has to keep saying.
4495    ///
4496    /// One flag today. `volatile` says the access happens exactly once and is never moved or
4497    /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
4498    /// one are the same instruction over the same address, so a pass that puts two accesses
4499    /// together would put these together too. Carried rather than checked here, because the pass
4500    /// that has to refuse is a long way down and this is the last place the answer is known.
4501    ///
4502    /// The instructions this compiler writes for itself get nothing, which is the right answer
4503    /// for all of them: a prologue, a spill and the moves around a call were asked for by the
4504    /// machine rather than by the program.
4505    ///
4506    /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
4507    /// the two ends of a `long double` copy that are the program's own memory, and the compare
4508    /// and exchange and the read modify write. An `asm` statement does not, and it is the one
4509    /// exception on purpose. What the flag says there is that the statement stays even when
4510    /// nothing reads what it wrote, which is a different sentence about a different thing, and
4511    /// every `asm` is already fixed where it stands whether the word was written or not.
4512    fn carried(&self, inst: Inst) -> mir::Flags {
4513        if self.source[inst].flags.contains(Flags::VOLATILE) {
4514            mir::Flags::VOLATILE
4515        } else {
4516            mir::Flags::NONE
4517        }
4518    }
4519
4520    /// Build the machine instruction a match calls for.
4521    fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
4522        let rule: &Rule = TABLE.rule(matched);
4523        let pieces = rule.replacement;
4524        let Some(Piece::App { head, arity }) = pieces.first() else {
4525            return Err(self.unsupported(inst));
4526        };
4527        let opcode = head.strip_prefix(PREFIX).ok_or_else(|| self.unsupported(inst))?;
4528        let form = x86_64::form(opcode).ok_or_else(|| self.unsupported(inst))?;
4529
4530        let mut read = Read::default();
4531        let mut at = 1;
4532        for _ in 0..*arity {
4533            at = self.read(inst, pieces, at, &matched.bindings, &mut read)?;
4534        }
4535
4536        let descs = form.operands();
4537        let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
4538        if descs.len() - writes != read.regs.len() {
4539            return Err(self.unsupported(inst));
4540        }
4541
4542        // The first thing the instruction writes is what it computes, and any others are
4543        // registers the machine destroys on the way, which are fresh because nothing else is in
4544        // them and nothing reads them. An instruction that writes nothing at all is one whose
4545        // whole purpose is its effect, which is what a store is, and there is no result to put
4546        // anywhere.
4547        let mut regs = Vec::new();
4548        if writes > 0 {
4549            let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
4550            regs.push(self.new_reg(result));
4551            // The rest are the registers the machine destroys on the way, and the class each is in
4552            // is the one the instruction's description gives it rather than a guess, so that an
4553            // instruction that wrecks a register in the other file says so.
4554            regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
4555        } else if self.source[inst].first_result.is_some() {
4556            // A rule that throws away a value the IR gave a name to would leave every reader of
4557            // that name with nothing to read, so it is a rule this and the target disagree about.
4558            return Err(self.unsupported(inst));
4559        }
4560        regs.extend(read.regs.iter().copied());
4561
4562        let block = self.at.expect("a block is being filled");
4563        let opcode = mir::Opcode::new(self.names.intern(head));
4564        let (span, flags) = (self.source.span(inst), self.carried(inst));
4565        let mut build = self.out.build(block, opcode).at(span).flags(flags);
4566        for (desc, reg) in descs.iter().zip(regs) {
4567            let operand = mir::Operand {
4568                reg,
4569                class: desc.class,
4570                role: desc.role,
4571                constraint: desc.constraint,
4572            };
4573            build = build.operand(operand);
4574        }
4575        if let Some(mem) = read.mem {
4576            build = build.mem(mem);
4577        }
4578        if let Some(imm) = read.imm {
4579            build = build.imm(imm);
4580        }
4581        build.finish();
4582        Ok(())
4583    }
4584
4585    /// Read one argument of a replacement, which is a register, a number or an address.
4586    ///
4587    /// Gives back the position after it, because a replacement is flat and an address takes
4588    /// arguments of its own.
4589    fn read(
4590        &mut self,
4591        inst: Inst,
4592        pieces: &'static [Piece],
4593        at: usize,
4594        bindings: &[Term],
4595        out: &mut Read,
4596    ) -> Result<usize, Unsupported> {
4597        match pieces.get(at) {
4598            Some(Piece::Int(value)) => {
4599                out.imm = i64::try_from(*value).ok();
4600                Ok(at + 1)
4601            }
4602            // A number the rule worked out of the ones it matched rather than one it wrote down,
4603            // which is an immediate once it has been worked out and is read here as one. It gives
4604            // nothing back when a binding it reads is a register, and a replacement that cannot be
4605            // built is a rule this file and the matcher disagree about, which is what `unsupported`
4606            // is for.
4607            Some(Piece::Computed { work, .. }) => {
4608                let matched: Vec<Option<i128>> = bindings
4609                    .iter()
4610                    .map(|term| match *term {
4611                        Term::Num(value) => Some(value),
4612                        _ => None,
4613                    })
4614                    .collect();
4615                let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
4616                out.imm = i64::try_from(number).ok();
4617                Ok(at + 1)
4618            }
4619            Some(Piece::Var { index, .. }) => {
4620                match bindings.get(*index) {
4621                    Some(&Term::Reg(value)) => {
4622                        let reg = self.reg_of(value)?;
4623                        out.regs.push(reg);
4624                    }
4625                    Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
4626                    // A pattern binds a register or a number and nothing else, so this is a
4627                    // rule the matcher and this file disagree about.
4628                    _ => return Err(self.unsupported(inst)),
4629                }
4630                Ok(at + 1)
4631            }
4632            Some(Piece::App { head, arity }) => {
4633                let kind = x86_64::address(head).ok_or_else(|| self.unsupported(inst))?;
4634                let mut inner = Read::default();
4635                let mut next = at + 1;
4636                for _ in 0..*arity {
4637                    next = self.read(inst, pieces, next, bindings, &mut inner)?;
4638                }
4639                let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
4640                out.mem = Some(mem);
4641                Ok(next)
4642            }
4643            None => Err(self.unsupported(inst)),
4644        }
4645    }
4646
4647    /// The register a value is in, materializing it if it is a constant that has not been put in
4648    /// one yet.
4649    ///
4650    /// A constant is written where it is wanted rather than where the IR defined it, and where it
4651    /// is wanted is a block that need not be the one the IR defined it in. So the register holding
4652    /// one is only good inside the block it was written into, and a second block that wants the
4653    /// same constant gets its own. Anything else is a register read where nothing wrote it: the
4654    /// IR guarantees a definition dominates its uses, and this moved the definition.
4655    ///
4656    /// Writing the number again is also the right answer and not merely the safe one. It is one
4657    /// instruction that reads nothing, which is cheaper than holding a register live across a
4658    /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
4659    fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
4660        let constant = match self.source[value].def {
4661            Def::Result { inst, .. } => {
4662                (self.source[inst].opcode == Opcode::IConst).then_some(inst)
4663            }
4664            Def::Param { .. } => None,
4665        };
4666        let here = self.at.expect("a block is being filled");
4667        if let Some(reg) = self.regs[value.index()] {
4668            if constant.is_none() || self.written[value.index()] == Some(here) {
4669                return Ok(reg);
4670            }
4671        }
4672        if let Some(inst) = constant {
4673            // Cleared so that the register the constant is written into is a new one rather than
4674            // the one the block above wrote, which is still being read up there.
4675            self.regs[value.index()] = None;
4676            // Nothing is refused here. A constant is written on its own, out of the loop over the
4677            // block, and the operands of the rule that writes one are the number and nothing else.
4678            let matched = self
4679                .select(inst, &HashSet::new())
4680                .map(|(_, matched)| matched)
4681                .ok_or_else(|| self.unsupported(inst))?;
4682            self.emit(inst, &matched)?;
4683            // The same mark the loop over the instructions makes, and it has to be made here as
4684            // well because this is the only place a constant is ever selected: the loop skips one
4685            // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
4686            // would be reported as a rule nothing reaches.
4687            self.fired.mark(matched.rule);
4688            self.written[value.index()] = Some(here);
4689            return Ok(self.regs[value.index()].expect("a constant is written into a register"));
4690        }
4691        Ok(self.new_reg(value))
4692    }
4693
4694    /// Which register file a value of that type lives in.
4695    ///
4696    /// The vector one for the two float widths the machine has scalar instructions for and for the
4697    /// one it only moves, and the general purpose one for everything else. An eighty bit `long
4698    /// double` is in neither, and it is here rather than in the vector class on purpose: it would
4699    /// be put in a register that cannot hold it, and there is no rule that names one, so the
4700    /// instruction computing it is reported. The wrong class would make that a wrong program
4701    /// instead of a refused one.
4702    ///
4703    /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
4704    /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
4705    /// what the class buys is the moves: a register that holds the whole value is a register a
4706    /// spill, a reload and a copy are each one instruction for.
4707    fn class_of(&self, ty: Type) -> RegClass {
4708        if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
4709    }
4710
4711    /// A fresh register for a value, which is what the instruction computing it writes.
4712    ///
4713    /// Any declaration the value is a value of comes with it. Here rather than once at the end over
4714    /// the whole map, because a constant is written again in every block that wants one and the map
4715    /// only remembers the last of those registers, and a local held in a constant is a local that
4716    /// would otherwise be findable in one block of the function and nowhere else.
4717    fn new_reg(&mut self, value: Value) -> mir::Reg {
4718        if let Some(reg) = self.regs[value.index()] {
4719            return reg;
4720        }
4721        let reg = self.out.new_vreg(self.class_of(self.source[value].ty));
4722        self.regs[value.index()] = Some(reg);
4723        let source = self.source;
4724        for decl in source.value_decls(value) {
4725            self.out.named.push((decl, reg));
4726        }
4727        reg
4728    }
4729
4730    fn unsupported(&self, inst: Inst) -> Unsupported {
4731        let data = &self.source[inst];
4732        Unsupported::Inst {
4733            inst,
4734            term: Terms::new(self.source, inst, PLAIN).name(inst),
4735            opcode: data.opcode,
4736            ty: data.first_result.map(|result| self.source[result].ty),
4737        }
4738    }
4739}
4740
4741/// What the arguments of one replacement came to.
4742#[derive(Debug, Default)]
4743struct Read {
4744    regs: Vec<mir::Reg>,
4745    imm: Option<i64>,
4746    mem: Option<mir::Mem>,
4747}
4748
4749/// The addressing mode an address constructor's arguments make.
4750///
4751/// One arm per constructor rather than a question asked of the kind, because what the arguments
4752/// mean is the whole of what tells the four apart: the same register is a base in one and an
4753/// index in another, and the same constant is a scale in one and a displacement in another.
4754fn address(kind: x86_64::Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
4755    let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
4756    match kind {
4757        x86_64::Address::BaseIndexScale => {
4758            let base = regs.next()?;
4759            let index = regs.next()?;
4760            Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
4761        }
4762        x86_64::Address::IndexScale => Some(mir::Mem {
4763            base: None,
4764            index: Some(regs.next()?),
4765            scale: u8::try_from(read.imm?).ok()?,
4766            disp: 0,
4767            symbol: None,
4768            block: None,
4769            reach: mir::Reach::Itself,
4770            segment: None,
4771        }),
4772        x86_64::Address::Base => Some(mir::Mem::at(regs.next()?)),
4773        // The rule that writes this has a guard saying the constant fits, so a displacement that
4774        // does not is a rule and a target that disagree rather than a program this cannot compile.
4775        x86_64::Address::BaseOffset => {
4776            Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
4777        }
4778    }
4779}
4780
4781/// The table this selector matches with.
4782///
4783/// One target for now, because one target has a rule file. Which table to use becomes a question
4784/// the moment a second one does, and the answer will be the target the session was given rather
4785/// than a constant here.
4786static TABLE: &Table = &crate::select::x86_64::TABLE;
4787
4788#[cfg(test)]
4789mod tests {
4790    use rucc_ir::{
4791        AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
4792    };
4793    use rucc_regalloc::assign::Env;
4794    use rucc_target::x86_64::{FRAME, REGS, SYSV};
4795
4796    use super::*;
4797    use crate::finish::{Convention, finish};
4798    use crate::frame::{Frame, Incoming, Layout};
4799
4800    /// A function of as many 64 bit parameters as the test wants, and the block they are in.
4801    fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
4802        let mut names = Interner::new();
4803        let mut func = Func::new(names.intern("f"), Signature::new());
4804        let block = func.create_block();
4805        let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
4806        (names, func, block, values)
4807    }
4808
4809    /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
4810    /// Neither field reaches selection, which is the point of saying it once here.
4811    fn plain() -> MemInfo {
4812        MemInfo {
4813            size: 0,
4814            align: 1,
4815            order: MemOrder::NotAtomic,
4816            tbaa: None,
4817            owns: 0,
4818            restrict: Restrict::NONE,
4819        }
4820    }
4821
4822    /// What the allocator is given: every integer register the convention offers except two, held
4823    /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
4824    /// somewhere to be read into. Which two does not matter, and holding back the last two the
4825    /// convention would reach for leaves every expectation below unchanged.
4826    fn env() -> Env {
4827        const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
4828        let order: Vec<PhysReg> =
4829            SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
4830        Env::new().with(x86_64::GPR, &order, &SCRATCH)
4831    }
4832
4833    /// The machine IR text a function lowers to.
4834    fn lower(names: &mut Interner, source: &Func) -> String {
4835        let out = func(source, names, &SYSV, &Elsewhere::default())
4836            .expect("every instruction has a rule");
4837        mir::print_func(&out.func, names, &REGS)
4838    }
4839
4840    #[test]
4841    fn an_addition_of_two_registers_is_one_instruction() {
4842        let i32 = Type::int(32);
4843        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4844        let mut build = Builder::new(&mut func, block);
4845        build.binary(Opcode::Add, args[0], args[1], Flags::default());
4846
4847        assert_eq!(
4848            lower(&mut names, &func),
4849            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4850             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
4851        );
4852    }
4853
4854    #[test]
4855    fn a_constant_operand_becomes_an_immediate() {
4856        let i32 = Type::int(32);
4857        let (mut names, mut func, block, args) = blank(&[i32]);
4858        let mut build = Builder::new(&mut func, block);
4859        let seven = build.iconst(i32, 7);
4860        build.binary(Opcode::Add, args[0], seven, Flags::default());
4861
4862        // The constant is in the instruction and nothing was written to hold it, which is what
4863        // materializing one where a register for it is wanted buys.
4864        assert_eq!(
4865            lower(&mut names, &func),
4866            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4867             %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
4868        );
4869    }
4870
4871    #[test]
4872    fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
4873        let i64 = Type::int(64);
4874        let (mut names, mut func, block, args) = blank(&[i64]);
4875        let mut build = Builder::new(&mut func, block);
4876        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
4877        build.binary(Opcode::Add, args[0], big, Flags::default());
4878
4879        // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
4880        // turns a number this wide down, so it does not fire, and the next way of showing the
4881        // operand puts it in a register.
4882        assert_eq!(
4883            lower(&mut names, &func),
4884            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4885             %1:gpr = x64.mov_ri_64 2147483648\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
4886        );
4887    }
4888
4889    #[test]
4890    fn an_index_calculation_folds_into_an_address() {
4891        let i64 = Type::int(64);
4892        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4893        let mut build = Builder::new(&mut func, block);
4894        let four = build.iconst(i64, 4);
4895        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4896        build.binary(Opcode::Add, args[0], scaled, Flags::default());
4897
4898        // Three IR instructions and one machine instruction. The multiply is gone because the
4899        // rule that matched reached down and took it.
4900        assert_eq!(
4901            lower(&mut names, &func),
4902            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4903             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
4904        );
4905    }
4906
4907    #[test]
4908    fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
4909        let i64 = Type::int(64);
4910        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4911        let mut build = Builder::new(&mut func, block);
4912        let four = build.iconst(i64, 4);
4913        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4914        let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
4915        build.binary(Opcode::Add, first, scaled, Flags::default());
4916
4917        // Both readers have room for a scaled index, so both of them take it and nothing is left
4918        // to read the multiply. Three IR instructions become two machine ones, where refusing to
4919        // fold into either reader would have left three.
4920        assert_eq!(
4921            lower(&mut names, &func),
4922            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4923             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n    \
4924             %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
4925        );
4926    }
4927
4928    #[test]
4929    fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
4930        let i64 = Type::int(64);
4931        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4932        let mut build = Builder::new(&mut func, block);
4933        let four = build.iconst(i64, 4);
4934        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4935        build.binary(Opcode::Add, args[0], scaled, Flags::default());
4936        build.store(scaled, args[0], plain(), Flags::default());
4937
4938        // The addition has room for the multiply and the store does not: what a store writes is
4939        // a register, and no rule reaches through it. Folding into the addition alone would
4940        // leave the multiply where it is for the store to read and do the work twice, so the
4941        // multiply is put back and both readers read the register it wrote.
4942        let text = lower(&mut names, &func);
4943        assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
4944        assert!(text.contains("x64.add_rr_64"), "{text}");
4945    }
4946
4947    #[test]
4948    fn a_shift_by_a_register_asks_for_it_in_cl() {
4949        let i32 = Type::int(32);
4950        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4951        let mut build = Builder::new(&mut func, block);
4952        build.binary(Opcode::Shl, args[0], args[1], Flags::default());
4953
4954        // The fixed register is not in the rule. It is what the target says the instruction does
4955        // with its operands, and the allocator is what will act on it.
4956        let text = lower(&mut names, &func);
4957        assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
4958    }
4959
4960    #[test]
4961    fn a_division_names_the_registers_and_the_register_it_destroys() {
4962        let i32 = Type::int(32);
4963        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4964        let mut build = Builder::new(&mut func, block);
4965        build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
4966
4967        // Two definitions, because a division writes the remainder whether anybody wanted it or
4968        // not, and the second one is early because it is destroyed before the operands are read.
4969        let text = lower(&mut names, &func);
4970        assert!(
4971            text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
4972            "{text}"
4973        );
4974    }
4975
4976    #[test]
4977    fn a_load_reads_through_the_register_the_address_is_in() {
4978        let i64 = Type::int(64);
4979        let (mut names, mut func, block, args) = blank(&[i64]);
4980        let mut build = Builder::new(&mut func, block);
4981        build.load(Type::int(32), args[0], plain(), Flags::default());
4982
4983        assert_eq!(
4984            lower(&mut names, &func),
4985            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4986             %1:gpr = x64.mov_rm_32 [%0]\n}\n"
4987        );
4988    }
4989
4990    #[test]
4991    fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
4992        let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
4993        let mut build = Builder::new(&mut func, block);
4994        build.store(args[0], args[1], plain(), Flags::default());
4995
4996        // The value is the first parameter and the address is the second, and the instruction
4997        // takes them the other way round. Getting that backwards would compile to a store of the
4998        // address into the value, which is a program that runs and does the wrong thing.
4999        assert_eq!(
5000            lower(&mut names, &func),
5001            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5002             %1:gpr($rsi) = x64.arg_val_64\n    x64.mov_mr_32 %0, [%1]\n}\n"
5003        );
5004    }
5005
5006    #[test]
5007    fn an_address_with_a_constant_added_folds_into_the_access() {
5008        let i64 = Type::int(64);
5009        let (mut names, mut func, block, args) = blank(&[i64]);
5010        let mut build = Builder::new(&mut func, block);
5011        let twelve = build.iconst(i64, 12);
5012        let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
5013        build.load(Type::int(64), field, plain(), Flags::default());
5014
5015        // Two IR instructions and one machine instruction, which is what every read of a field
5016        // of a structure comes to.
5017        assert_eq!(
5018            lower(&mut names, &func),
5019            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
5020             %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
5021        );
5022    }
5023
5024    #[test]
5025    fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
5026        let i64 = Type::int(64);
5027        let (mut names, mut func, block, args) = blank(&[i64]);
5028        let mut build = Builder::new(&mut func, block);
5029        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
5030        let far = build.binary(Opcode::Add, args[0], big, Flags::default());
5031        build.load(Type::int(32), far, plain(), Flags::default());
5032
5033        // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
5034        // this down, so the addition stays and the load reads through what it produced. Nobody
5035        // wrote that fallback: it is the next way of showing the operand.
5036        let text = lower(&mut names, &func);
5037        assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
5038        assert!(text.contains("x64.add_rr_64"), "{text}");
5039    }
5040
5041    #[test]
5042    fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
5043        let i64 = Type::int(64);
5044        let (mut names, mut func, block, args) = blank(&[i64, i64]);
5045        let mut build = Builder::new(&mut func, block);
5046        let got = build.load(Type::int(8), args[0], plain(), Flags::default());
5047        build.store(got, args[1], plain(), Flags::default());
5048
5049        // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
5050        // most one memory operand, and there is no rule that takes two, so the load is left where
5051        // it is and the store reads the register it wrote.
5052        assert_eq!(
5053            lower(&mut names, &func),
5054            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
5055             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.mov_rm_8 [%0]\n    \
5056             x64.mov_mr_8 %2, [%1]\n}\n"
5057        );
5058    }
5059
5060    #[test]
5061    fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
5062        let i64 = Type::int(64);
5063        let (mut names, mut source, block, args) = blank(&[i64]);
5064        let mut build = Builder::new(&mut source, block);
5065        build.load(Type::int(128), args[0], plain(), Flags::default());
5066
5067        // The width is the whole of what is wrong here, so the width is in the message: `load`
5068        // on its own is written about at every other width and would send a reader looking in
5069        // the wrong place.
5070        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5071            .expect_err("nothing loads 128 bits");
5072        assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
5073    }
5074
5075    #[test]
5076    fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
5077        let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
5078        let mut build = Builder::new(&mut func, block);
5079        build.ret(&[args[0]]);
5080
5081        // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
5082        // is what the target says the instruction does with its operand, and the allocator is
5083        // what will act on it. There is no `ret` here, because giving the frame back has to
5084        // happen between this and leaving and the frame is not worked out yet.
5085        assert_eq!(
5086            lower(&mut names, &func),
5087            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5088             x64.ret_val_32 %0($rax)\n}\n"
5089        );
5090    }
5091
5092    #[test]
5093    fn a_return_of_two_values_asks_for_the_second_register_as_well() {
5094        let i64 = Type::int(64);
5095        let (mut names, mut func, block, args) = blank(&[i64, i64]);
5096        let mut build = Builder::new(&mut func, block);
5097        build.ret(&[args[0], args[1]]);
5098
5099        // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
5100        // halves are integers, so the second is in the second integer return register, and both
5101        // pseudos say so the same way the one for a single value does.
5102        assert_eq!(
5103            lower(&mut names, &func),
5104            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
5105             %1:gpr($rsi) = x64.arg_val_64\n    x64.ret_val_64 %0($rax)\n    \
5106             x64.ret_val2_64 %1($rdx)\n}\n"
5107        );
5108    }
5109
5110    #[test]
5111    fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
5112        let f64 = Type::float(rucc_ir::Float::F64);
5113        let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
5114        let mut build = Builder::new(&mut func, block);
5115        build.ret(&[args[0], args[1]]);
5116
5117        // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
5118        // neither half is the second of anything and the `double` is in `xmm0` rather than in the
5119        // register a second `double` would have been in. Getting this wrong is not a crash: the
5120        // caller reads a register nobody wrote, and this is where that is ruled out.
5121        assert_eq!(
5122            lower(&mut names, &func),
5123            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
5124             %1:gpr($rdi) = x64.arg_val_64\n    x64.ret_val_f64 %0($xmm0)\n    \
5125             x64.ret_val_64 %1($rax)\n}\n"
5126        );
5127    }
5128
5129    #[test]
5130    fn two_of_the_same_file_back_take_the_first_two_of_it() {
5131        let f64 = Type::float(rucc_ir::Float::F64);
5132        let (mut names, mut func, block, args) = blank(&[f64, f64]);
5133        let mut build = Builder::new(&mut func, block);
5134        build.ret(&[args[0], args[1]]);
5135
5136        // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
5137        // above and counts in its own file the same way.
5138        assert_eq!(
5139            lower(&mut names, &func),
5140            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
5141             %1:xmm($xmm1) = x64.arg_val_f64\n    x64.ret_val_f64 %0($xmm0)\n    \
5142             x64.ret_val2_f64 %1($xmm1)\n}\n"
5143        );
5144    }
5145
5146    /// A function whose answer goes back through memory, with the pointer to the space for it in
5147    /// front of whatever else it takes. Only the signature says it is one.
5148    fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
5149        let mut names = Interner::new();
5150        let sret = Abi::Sret { size: 32, align: 8 };
5151        let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
5152        signature.params.extend(params.iter().copied().map(Param::new));
5153        let mut func = Func::new(names.intern("f"), signature);
5154        let block = func.create_block();
5155        let space = func.append_param(block, Type::PTR);
5156        let values = std::iter::once(space)
5157            .chain(params.iter().map(|&ty| func.append_param(block, ty)))
5158            .collect();
5159        (names, func, block, values)
5160    }
5161
5162    #[test]
5163    fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
5164        let (mut names, mut func, block, _) = returning_through_memory(&[]);
5165        Builder::new(&mut func, block).ret(&[]);
5166
5167        // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
5168        // carries nothing, because the value went into the space the caller handed over, and the
5169        // document still says that address comes back in `rax`. Nothing in the IR says it, so the
5170        // convention says it, and the pseudo is the one any other pointer return would use.
5171        assert_eq!(
5172            lower(&mut names, &func),
5173            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
5174             x64.ret_val_64 %0($rax)\n}\n"
5175        );
5176    }
5177
5178    #[test]
5179    fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
5180        let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
5181        let mut build = Builder::new(&mut func, block);
5182        build.store(args[1], args[0], plain(), Flags::default());
5183        build.ret(&[]);
5184
5185        // The register is a read at the end and not a move at the start, so it is live across
5186        // everything between the two and the allocator has to keep it somewhere. In a function
5187        // with a call in it that somewhere is a callee saved register, and the address comes back
5188        // into `rax` here rather than whatever the last instruction happened to leave there. That
5189        // is issue #333, and a store is enough to show the value outlives the entry block.
5190        let text = lower(&mut names, &func);
5191        assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
5192        assert!(text.ends_with("    x64.ret_val_64 %0($rax)\n}\n"), "{text}");
5193    }
5194
5195    #[test]
5196    fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
5197        let (mut names, mut func, block, args) = blank(&[Type::PTR]);
5198        let mut build = Builder::new(&mut func, block);
5199        build.store(args[0], args[0], plain(), Flags::default());
5200        build.ret(&[]);
5201
5202        // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
5203        // the one above and none of its meaning, and what tells them apart is the signature. A
5204        // `void` function leaves `rax` alone.
5205        assert!(!lower(&mut names, &func).contains("ret_val"));
5206    }
5207
5208    #[test]
5209    fn a_return_of_a_constant_puts_it_in_a_register_first() {
5210        let (mut names, mut func, block, _) = blank(&[]);
5211        let mut build = Builder::new(&mut func, block);
5212        let zero = build.iconst(Type::int(32), 0);
5213        build.ret(&[zero]);
5214
5215        // No rule returns an immediate, so the plan that offers one is turned down and the next
5216        // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
5217        // is appended to it.
5218        assert_eq!(
5219            lower(&mut names, &func),
5220            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
5221        );
5222    }
5223
5224    #[test]
5225    fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
5226        let (mut names, mut func, block, _) = blank(&[]);
5227        let mut build = Builder::new(&mut func, block);
5228        let zero = build.iconst(Type::int(32), 0);
5229        build.ret(&[zero]);
5230
5231        // The loop over the instructions passes a constant by, because a constant is written where
5232        // a register for it is first wanted rather than where the IR put it. So the only place a
5233        // rule about one is ever selected is the materialization, and a mark made in the loop
5234        // alone would report every rule about a constant as a rule nothing reaches.
5235        let out = super::func(&func, &mut names, &SYSV, &Elsewhere::default())
5236            .expect("every instruction has a rule");
5237        let rules = &crate::select::x86_64::TABLE.rules;
5238        let fired: Vec<&str> = rules
5239            .iter()
5240            .enumerate()
5241            .filter(|(index, _)| out.fired.has(*index))
5242            .map(|(_, rule)| rule.pattern)
5243            .collect();
5244        assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
5245    }
5246
5247    #[test]
5248    fn a_return_of_nothing_is_no_instruction_at_all() {
5249        let (mut names, mut func, block, _) = blank(&[]);
5250        let mut build = Builder::new(&mut func, block);
5251        build.ret(&[]);
5252
5253        // Every part of leaving a function that returns nothing is the epilogue's, and the
5254        // epilogue goes in after allocation. A block with nothing in it is the right answer here
5255        // rather than a function that could not be lowered.
5256        assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
5257    }
5258
5259    #[test]
5260    fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
5261        let (mut names, mut source, block, _) = blank(&[]);
5262        let mut build = Builder::new(&mut source, block);
5263        let zero = build.iconst(Type::int(32), 0);
5264        build.ret(&[zero]);
5265
5266        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5267            .expect("every instruction has a rule")
5268            .func;
5269        let env = env();
5270        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5271        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5272        finish(
5273            &mut out,
5274            &allocation,
5275            &frame,
5276            &Stack::default(),
5277            Convention::new(&SYSV, &FRAME),
5278            &mut names,
5279        );
5280
5281        // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
5282        // the value goes back, the target said where, and the allocator is what made it true. The
5283        // epilogue is what leaves, and this function needs no frame, so it is the return alone.
5284        //
5285        // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
5286        // so `rax` is the register the allocator tries first for the value the return reads, and
5287        // the constant is written straight into it.
5288        assert_eq!(
5289            mir::print_func(&out, &names, &REGS),
5290            "mfunc @f {\nblock0:\n    $rax = x64.mov_ri_32 0\n    \
5291             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
5292        );
5293    }
5294
5295    #[test]
5296    fn a_function_of_two_arguments_is_a_whole_function_now() {
5297        let i32 = Type::int(32);
5298        let (mut names, mut source, block, args) = blank(&[i32, i32]);
5299        let mut build = Builder::new(&mut source, block);
5300        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
5301        build.ret(&[sum]);
5302
5303        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5304            .expect("every instruction has a rule")
5305            .func;
5306        let env = env();
5307        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5308        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5309        finish(
5310            &mut out,
5311            &allocation,
5312            &frame,
5313            &Stack::default(),
5314            Convention::new(&SYSV, &FRAME),
5315            &mut names,
5316        );
5317
5318        // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
5319        // side exists for. Before it there was no way to write one: the allocator refuses a
5320        // function whose entry block takes parameters, because there is no edge into an entry
5321        // block for the moves that give a block parameter its value to go on.
5322        //
5323        // One move, and it is the one the machine's addition needs rather than one the allocator
5324        // owes anybody. Each argument stays in the register it arrived in, because the pseudo
5325        // that defines it insists on that register and the allocator now tries it first, and the
5326        // sum stays in the register the addition wrote it to until the return reads it out. The
5327        // copy in front of a two address instruction is what makes its destination one of the
5328        // registers it reads, and the source operand keeps its own name because the destination
5329        // is what the encoder writes.
5330        assert_eq!(
5331            mir::print_func(&out, &names, &REGS),
5332            "mfunc @f {\nblock0:\n    $rdi($rdi) = x64.arg_val_32\n    \
5333             $rsi($rsi) = x64.arg_val_32\n    \
5334             $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n    $rax = x64.mov_rr_64 $rdi\n    \
5335             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
5336        );
5337    }
5338
5339    #[test]
5340    fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
5341        let i64 = Type::int(64);
5342        let (mut names, mut source, block, args) = blank(&[i64; 7]);
5343        let mut build = Builder::new(&mut source, block);
5344        build.ret(&[args[6]]);
5345
5346        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5347            .expect("the seventh is read from memory");
5348
5349        // SysV passes six integers in registers and the seventh in the caller's memory, so six of
5350        // these are pseudos that encode to nothing and the seventh is a load that encodes to real
5351        // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
5352        // yet. What the walk hands on is which instruction is waiting, and for how far up the
5353        // caller's argument area, which is the bottom of it because it is the first one there.
5354        assert_eq!(lowered.stack.arguments.len(), 1);
5355        assert_eq!(lowered.stack.arguments[0].1, 0);
5356        let text = mir::print_func(&lowered.func, &names, &REGS);
5357        assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
5358        assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
5359    }
5360
5361    #[test]
5362    fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
5363        let i64 = Type::int(64);
5364        let (mut names, mut source, block, args) = blank(&[i64; 8]);
5365        let mut build = Builder::new(&mut source, block);
5366        let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
5367        build.ret(&[sum]);
5368
5369        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5370            .expect("both are read from memory");
5371        let stack = lowered.stack;
5372        let mut out = lowered.func;
5373        let env = env();
5374        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5375        let layout = stack.layout(Layout::new(&SYSV, REGS));
5376        let frame = Frame::of(&out, &allocation, &layout);
5377        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5378
5379        // A leaf that takes no frame, so the stack pointer never moves and the only thing between
5380        // it and the caller's arguments is the return address the call pushed. The seventh
5381        // parameter is at the bottom of the caller's argument area and the eighth is one word
5382        // further up, which is the eight bytes between the two offsets.
5383        let text = mir::print_func(&out, &names, &REGS);
5384        assert_eq!(frame.size(), 0);
5385        assert_eq!(frame.incoming(), Incoming::from_stack(8));
5386        assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
5387        assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
5388    }
5389
5390    #[test]
5391    fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
5392        let i64 = Type::int(64);
5393        let (mut names, mut source, block, args) = blank(&[i64; 7]);
5394        let wide = slot(&mut source, block, 64, 32);
5395        let mut build = Builder::new(&mut source, block);
5396        build.store(args[6], wide, plain(), Flags::default());
5397        build.ret(&[args[6]]);
5398
5399        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5400            .expect("every instruction has a rule");
5401        let stack = lowered.stack;
5402        let mut out = lowered.func;
5403        let env = env();
5404        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5405        let layout = stack.layout(Layout::new(&SYSV, REGS));
5406        let frame = Frame::of(&out, &allocation, &layout);
5407        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5408
5409        // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
5410        // which throws away how far the caller's stack was. So the load the lowering wrote off the
5411        // stack pointer is rewritten to read through the frame pointer, at the one distance that
5412        // survives: the word the prologue pushed the frame pointer into, and the return address
5413        // above it.
5414        let text = mir::print_func(&out, &names, &REGS);
5415        assert_eq!(frame.realign(), Some(32));
5416        assert_eq!(frame.incoming(), Incoming::from_frame(16));
5417        assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
5418        assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
5419    }
5420
5421    #[test]
5422    fn a_jump_is_the_edge_and_nothing_else() {
5423        let i32 = Type::int(32);
5424        let (mut names, mut source, entry, args) = blank(&[i32]);
5425        let next = source.create_block();
5426        let got = source.append_param(next, i32);
5427        Builder::new(&mut source, entry).jump(next, &[args[0]]);
5428        Builder::new(&mut source, next).ret(&[got]);
5429
5430        // Two blocks and two instructions, and the jump is neither of them. What it was is the
5431        // arm on the first block, and what the arm carries is the argument it was called with.
5432        assert_eq!(
5433            lower(&mut names, &source),
5434            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
5435             block1(%1:gpr):\n    x64.ret_val_32 %1($rax)\n}\n"
5436        );
5437    }
5438
5439    /// A block that reads what a block below it writes is filled after it, not before it.
5440    ///
5441    /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
5442    /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
5443    /// Filling them in the order they are written reaches the read in `early` first, and reading
5444    /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
5445    /// what it does is give its answer the register its operand is already in, and that is not
5446    /// the register the read minted. Nothing writes the register the read minted. The printer
5447    /// says `%?` for a register nothing defines, which is what this looks for, and what came out
5448    /// of the real bug was SQLite loading a stack slot no store ever reached.
5449    #[test]
5450    fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
5451        let i64 = Type::int(64);
5452        let (mut names, mut source, entry, args) = blank(&[i64, i64]);
5453        let early = source.create_block();
5454        let late = source.create_block();
5455        let exit = source.create_block();
5456
5457        Builder::new(&mut source, entry).jump(late, &[]);
5458        let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
5459        Builder::new(&mut source, early).ret(&[ptr]);
5460        let mut build = Builder::new(&mut source, late);
5461        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5462        build.br_if(cond, early, &[], exit, &[]);
5463        Builder::new(&mut source, exit).ret(&[args[1]]);
5464
5465        let text = lower(&mut names, &source);
5466        assert!(!text.contains("%?"), "every register has something that writes it: {text}");
5467    }
5468
5469    /// A constant is written where it is wanted rather than where the IR defined it, and two
5470    /// blocks wanting the same one is two places. Writing it once and reading it in both is a
5471    /// register read where nothing wrote it, unless the block it was written in happens to
5472    /// dominate the other, which nothing here checks and which the second arm of a branch never
5473    /// does. Each block gets its own copy of the number instead.
5474    #[test]
5475    fn a_constant_two_blocks_want_is_written_in_both_of_them() {
5476        let i32 = Type::int(32);
5477        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5478        let then = source.create_block();
5479        let other = source.create_block();
5480        let join = source.create_block();
5481        let got = source.append_param(join, i32);
5482
5483        let mut build = Builder::new(&mut source, entry);
5484        let seven = build.iconst(i32, 7);
5485        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5486        build.br_if(cond, then, &[], other, &[]);
5487        // Both arms want the seven in a register, because a block argument is never an immediate,
5488        // and neither arm dominates the other.
5489        Builder::new(&mut source, then).jump(join, &[seven]);
5490        Builder::new(&mut source, other).jump(join, &[seven]);
5491        Builder::new(&mut source, join).ret(&[got]);
5492
5493        let text = lower(&mut names, &source);
5494        assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
5495    }
5496
5497    /// An argument on an edge out of a block that leaves two ways is read after every instruction
5498    /// of the block is written, and reading one can write an instruction, which would land after
5499    /// the branch that has already jumped past it. The branch goes back on the end.
5500    #[test]
5501    fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
5502        let i32 = Type::int(32);
5503        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5504        let then = source.create_block();
5505        let join = source.create_block();
5506        let got = source.append_param(join, i32);
5507
5508        let mut build = Builder::new(&mut source, entry);
5509        let nine = build.iconst(i32, 9);
5510        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5511        build.br_if(cond, then, &[], join, &[nine]);
5512        Builder::new(&mut source, then).jump(join, &[args[0]]);
5513        Builder::new(&mut source, join).ret(&[got]);
5514
5515        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5516            .expect("every instruction has a rule")
5517            .func;
5518        let entry = out.entry().expect("an entry block");
5519        let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
5520        let branch = names.intern("x64.br_cond_8");
5521        assert_eq!(
5522            out[last].opcode,
5523            mir::Opcode::new(branch),
5524            "the branch is last: {}",
5525            mir::print_func(&out, &names, &REGS)
5526        );
5527    }
5528
5529    #[test]
5530    fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
5531        let i32 = Type::int(32);
5532        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5533        let then = source.create_block();
5534        let other = source.create_block();
5535        let mut build = Builder::new(&mut source, entry);
5536        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5537        build.br_if(cond, then, &[], other, &[]);
5538        Builder::new(&mut source, then).ret(&[args[0]]);
5539        Builder::new(&mut source, other).ret(&[args[1]]);
5540
5541        // The comparison writes a byte and the branch reads it, and neither says a block. Both
5542        // arms are on the entry block, in the order the branch took them, so the arm that runs
5543        // when the condition holds is the first.
5544        assert_eq!(
5545            lower(&mut names, &source),
5546            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5547             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
5548             x64.br_cond_8 %2, block1, block2\n\n\
5549             block1:\n    x64.ret_val_32 %0($rax)\n\n\
5550             block2:\n    x64.ret_val_32 %1($rax)\n}\n"
5551        );
5552    }
5553
5554    /// A choice between two values, which is one instruction and no blocks at all.
5555    ///
5556    /// The arms come out the other way round from the IR, because a conditional move overwrites its
5557    /// destination and the destination is the arm taken when the condition does not hold. The
5558    /// condition arrives last for the same reason: it is read by the test in front of the move
5559    /// rather than by the move.
5560    #[test]
5561    fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
5562        let i32 = Type::int(32);
5563        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5564        let mut build = Builder::new(&mut source, entry);
5565        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5566        let picked = build.select(cond, args[0], args[1]);
5567        build.ret(&[picked]);
5568
5569        assert_eq!(
5570            lower(&mut names, &source),
5571            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5572             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
5573             %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n    \
5574             x64.ret_val_32 %3($rax)\n}\n"
5575        );
5576    }
5577
5578    #[test]
5579    fn a_branch_over_a_block_is_a_whole_function_now() {
5580        let i32 = Type::int(32);
5581        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5582        let then = source.create_block();
5583        let other = source.create_block();
5584        let join = source.create_block();
5585        let got = source.append_param(join, i32);
5586        let mut build = Builder::new(&mut source, entry);
5587        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5588        build.br_if(cond, then, &[], other, &[]);
5589        let mut build = Builder::new(&mut source, then);
5590        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
5591        build.jump(join, &[sum]);
5592        Builder::new(&mut source, other).jump(join, &[args[1]]);
5593        Builder::new(&mut source, join).ret(&[got]);
5594
5595        // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
5596        // the way a front end writes it: both arms of the branch are blocks of their own and the
5597        // return is the block they meet at. No edge here is critical, because the two arms out of
5598        // the entry carry nothing and the two arms into the join each leave a block that goes
5599        // nowhere else, so each has its own end to put its move at.
5600        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5601            .expect("every instruction has a rule")
5602            .func;
5603        assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
5604        let env = env();
5605        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5606        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5607        finish(
5608            &mut out,
5609            &allocation,
5610            &frame,
5611            &Stack::default(),
5612            Convention::new(&SYSV, &FRAME),
5613            &mut names,
5614        );
5615
5616        // One epilogue, on the join, which is the one block the function leaves from, and the
5617        // moves that give the join its parameter are at the end of each arm. Every register is
5618        // physical and the branch is still a branch on a register, because turning it into a
5619        // `test` and a `jcc` is the block layout's and there is no block layout yet.
5620        let text = mir::print_func(&out, &names, &REGS);
5621        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
5622        assert!(text.contains("x64.br_cond_8"), "{text}");
5623        assert!(text.contains("x64.add_rr_32"), "{text}");
5624        assert!(!text.contains('%'), "{text}");
5625    }
5626
5627    #[test]
5628    fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
5629        let i32 = Type::int(32);
5630        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5631        let then = source.create_block();
5632        let join = source.create_block();
5633        let got = source.append_param(join, i32);
5634        let mut build = Builder::new(&mut source, entry);
5635        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5636        build.br_if(cond, then, &[], join, &[args[1]]);
5637        Builder::new(&mut source, then).jump(join, &[args[0]]);
5638        let mut build = Builder::new(&mut source, join);
5639        let twice = build.binary(Opcode::Add, got, got, Flags::default());
5640        build.ret(&[twice]);
5641
5642        // The else arm is critical: the entry block leaves two ways and the join is arrived at
5643        // two ways, and the arm carries a value. Without splitting it the allocator asserts,
5644        // because the move that gives the join its parameter would have to run at the end of a
5645        // block that also goes to the other arm.
5646        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5647            .expect("every instruction has a rule")
5648            .func;
5649        assert_eq!(crate::split::critical(&mut out), 1);
5650        let env = env();
5651        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5652        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5653        finish(
5654            &mut out,
5655            &allocation,
5656            &frame,
5657            &Stack::default(),
5658            Convention::new(&SYSV, &FRAME),
5659            &mut names,
5660        );
5661
5662        // The block the split added is where the move went, and it is the whole of that block.
5663        let text = mir::print_func(&out, &names, &REGS);
5664        assert_eq!(out.block_count(), 4, "{text}");
5665        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
5666    }
5667
5668    #[test]
5669    fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
5670        let i32 = Type::int(32);
5671        let (mut names, mut source, block, args) = blank(&[i32, i32]);
5672        let sig =
5673            source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
5674        let callee = names.intern("g");
5675        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
5676        let got = source[call].first_result.expect("an integer comes back");
5677        Builder::new(&mut source, block).ret(&[got]);
5678
5679        // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
5680        // them, so what the call reads is what arrived, and the whole of the convention is in the
5681        // constraints rather than in a move.
5682        let text = lower(&mut names, &source);
5683        assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
5684        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
5685        // What the call writes is the value that comes back and then every register the callee is
5686        // free to destroy, in both classes, which is the whole of what stops the allocator from
5687        // leaving something in one of them.
5688        assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
5689        assert!(text.contains("$xmm15 = x64.call"), "{text}");
5690    }
5691
5692    #[test]
5693    fn what_the_frame_owes_a_call_comes_back_with_the_function() {
5694        let i32 = Type::int(32);
5695        let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
5696
5697        let (mut names, mut source, block, args) = blank(&[i32]);
5698        let sig = sig(&mut source);
5699        let callee = names.intern("g");
5700        Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
5701        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5702            .expect("every instruction has a rule");
5703
5704        // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
5705        // owes the callee an aligned stack pointer and may not use the red zone.
5706        assert_eq!(out.stack.calls, Some(0));
5707        let layout = out.stack.layout(Layout::new(&SYSV, REGS));
5708        assert!(!layout.leaf);
5709        assert_eq!(layout.outgoing, 0);
5710
5711        // The same call under the other convention owes thirty two bytes for the callee to spill
5712        // its register arguments into, which is a fact about the convention and not about the call.
5713        let out = func(&source, &mut names, &x86_64::WIN64, &Elsewhere::default())
5714            .expect("every instruction has a rule");
5715        assert_eq!(out.stack.calls, Some(32));
5716
5717        // And a function that calls nothing is a leaf, which is what says it may use the red zone.
5718        let (mut names, mut source, block, args) = blank(&[i32]);
5719        Builder::new(&mut source, block).ret(&[args[0]]);
5720        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5721            .expect("every instruction has a rule");
5722        assert_eq!(out.stack.calls, None);
5723        assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
5724    }
5725
5726    /// A Windows variadic prologue writes the argument registers the signature did not name into
5727    /// the shadow space the caller already reserved, which makes every argument one run of words up
5728    /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
5729    /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
5730    #[test]
5731    fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
5732        let mut names = Interner::new();
5733        let params = [Type::int(32), Type::PTR];
5734        let signature = Signature::new().with_params(&params).variadic();
5735        let mut source = Func::new(names.intern("f"), signature);
5736        let block = source.create_block();
5737        let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
5738        let mut build = Builder::new(&mut source, block);
5739        let args = build.func().push_values(&values[1..]);
5740        build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
5741        build.ret(&[]);
5742
5743        let out = func(&source, &mut names, &x86_64::WIN64, &Elsewhere::default())
5744            .expect("every instruction has a rule");
5745        let text = mir::print_func(&out.func, &names, &REGS);
5746
5747        // Two named parameters, so the registers at the next two positions hold arguments nobody
5748        // named and both are written up into the caller's area. The displacement is empty here and
5749        // `finish` fills it in, the same way it does for a parameter the registers ran out before.
5750        assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
5751        assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
5752        assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
5753        assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
5754
5755        // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
5756        // sixteen bytes up, which is where the two arguments the signature does name stopped.
5757        assert_eq!(out.stack.arguments.len(), 3);
5758        assert_eq!(out.stack.arguments[2].1, 16);
5759    }
5760
5761    #[test]
5762    fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
5763        let i32 = Type::int(32);
5764        let (mut names, mut source, block, args) = blank(&[i32]);
5765        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
5766        let callee = names.intern("g");
5767        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
5768        let got = source[call].first_result.expect("an integer comes back");
5769        let mut build = Builder::new(&mut source, block);
5770        let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
5771        build.ret(&[sum]);
5772
5773        // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
5774        // question: `a` is read after the call and `rdi` is a register the call destroys.
5775        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5776            .expect("every instruction has a rule");
5777        let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
5778        let mut out = lowered.func;
5779        let env = env();
5780        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5781        let frame = Frame::of(&out, &allocation, &layout);
5782        finish(
5783            &mut out,
5784            &allocation,
5785            &frame,
5786            &Stack::default(),
5787            Convention::new(&SYSV, &FRAME),
5788            &mut names,
5789        );
5790
5791        // It went to a register the callee has to put back, and the prologue and epilogue are what
5792        // put it back, which is the whole bargain the two halves of a convention make.
5793        let text = mir::print_func(&out, &names, &REGS);
5794        assert!(text.contains("$rbx"), "{text}");
5795        assert!(!text.contains('%'), "{text}");
5796        assert_eq!(text.matches("x64.call").count(), 1, "{text}");
5797    }
5798
5799    #[test]
5800    fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
5801        let i64 = Type::int(64);
5802        let (mut names, mut source, block, args) = blank(&[i64]);
5803        let seven = vec![i64; 7];
5804        let sig = source.add_signature(Signature::new().with_params(&seven));
5805        let callee = names.intern("g");
5806        let passed = vec![args[0]; 7];
5807        Builder::new(&mut source, block).call(callee, sig, &passed);
5808
5809        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5810            .expect("the seventh goes to memory");
5811        // The bytes the call needs are on the layout the frame is worked out from, so that the
5812        // frame reserves as many as the widest call in the function asked for.
5813        assert_eq!(lowered.stack.calls, Some(8));
5814        let text = mir::print_func(&lowered.func, &names, &REGS);
5815        assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
5816    }
5817
5818    #[test]
5819    fn a_call_this_cannot_make_is_reported_rather_than_made() {
5820        let (mut names, mut source, block, _) = blank(&[]);
5821        let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
5822        let sig = source.add_signature(Signature::new().with_returns(&returns));
5823        let callee = names.intern("g");
5824        Builder::new(&mut source, block).call(callee, sig, &[]);
5825        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5826            .expect_err("a long double is on the x87");
5827        assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
5828    }
5829
5830    /// A `long double` on its own is a different answer, because on its own it comes back on the
5831    /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
5832    ///
5833    /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
5834    /// straight after it. That instruction has to be straight after it: the stack is one place and
5835    /// anything else that touched it before this ran would be looking at the value still on it.
5836    #[test]
5837    fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
5838        let (mut names, mut source, block, _) = blank(&[]);
5839        let long_double = Type::float(rucc_ir::Float::F80);
5840        let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
5841        let callee = names.intern("g");
5842        Builder::new(&mut source, block).call(callee, sig, &[]);
5843
5844        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5845            .expect("the value comes back in st0");
5846        let text = mir::print_func(&lowered.func, &names, &REGS);
5847        let after: Vec<&str> =
5848            text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
5849        assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
5850        assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
5851        // And the slot it went into is the sixteen bytes the type takes, like every other one.
5852        assert_eq!(lowered.stack.locals.len(), 1, "{text}");
5853        assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
5854    }
5855
5856    #[test]
5857    fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
5858        let i32 = Type::int(32);
5859        let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
5860        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
5861        let varargs = source.push_abis(&[]);
5862        let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
5863        let mut build = Builder::new(&mut source, block);
5864        let inst = InstData {
5865            args: build.func().push_values(&[args[0], args[1]]),
5866            extra: Extra::Call(info),
5867            ..InstData::new(Opcode::CallIndirect)
5868        };
5869        let called = build.inst(inst, &[i32]);
5870        let got = source[called].first_result.expect("an integer comes back");
5871        Builder::new(&mut source, block).ret(&[got]);
5872
5873        // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
5874        // the arguments are the ones behind it, and everything else about the call is what a call
5875        // to a name would have been.
5876        let text = lower(&mut names, &source);
5877        assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
5878        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
5879        assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
5880    }
5881
5882    #[test]
5883    fn an_instruction_no_rule_covers_is_reported() {
5884        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
5885        let mut build = Builder::new(&mut source, block);
5886        let operands = build.func().push_values(&[args[0]]);
5887        build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
5888
5889        // The mark that an object has come into being, which nothing writes an instruction for
5890        // yet: what it needs is a write over a range of the lifetime plane, and that is
5891        // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
5892        // message to add beyond the name.
5893        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5894            .expect_err("no rule writes the beginning of a lifetime");
5895        assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
5896
5897        // It produces nothing, so there is no type in the message and nothing invents one, and the
5898        // instruction comes back so a caller can ask the function where it was.
5899        let inst = failed.inst().expect("the instruction it is about");
5900        assert_eq!(source[inst].opcode, Opcode::MetaBegin);
5901    }
5902
5903    /// A barrier is written by name here, and what it is depends on the ordering and on nothing
5904    /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
5905    #[test]
5906    fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
5907        for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
5908            let (mut names, mut source, block, _) = blank(&[]);
5909            let mut build = Builder::new(&mut source, block);
5910            build
5911                .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
5912
5913            let text = lower(&mut names, &source);
5914            assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
5915        }
5916    }
5917
5918    /// A compare and exchange is written by name too, and at the width of the value rather than at
5919    /// the width of the address, which is the mistake worth pinning: everything here is a pointer
5920    /// and only the value says how many bytes the instruction touches.
5921    #[test]
5922    fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
5923        for bits in [8, 16, 32, 64] {
5924            let ty = Type::int(bits);
5925            let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
5926            let mut build = Builder::new(&mut source, block);
5927            let mem = build.func().add_mem(MemInfo {
5928                size: u64::from(bits / 8),
5929                align: bits / 8,
5930                order: MemOrder::SeqCst,
5931                ..plain()
5932            });
5933            let operands = build.func().push_values(&[args[0], args[1], args[2]]);
5934            build.inst(
5935                InstData {
5936                    args: operands,
5937                    extra: Extra::Mem(mem),
5938                    ..InstData::new(Opcode::Cmpxchg)
5939                },
5940                &[ty, Type::I1],
5941            );
5942
5943            // Two values out of one instruction, the first of them in the register the machine
5944            // reads the expected value out of, the second free for the allocator to place. The
5945            // address is the memory operand and neither of the two values is.
5946            let text = lower(&mut names, &source);
5947            let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
5948            assert!(text.contains(&written), "{bits}: {text}");
5949        }
5950    }
5951
5952    #[test]
5953    fn more_values_back_than_the_convention_has_registers_for_is_reported() {
5954        let i64 = Type::int(64);
5955        let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
5956        let mut build = Builder::new(&mut source, block);
5957        build.ret(&[args[0], args[1], args[2]]);
5958
5959        // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
5960        // gap in the rules but the convention saying no. The front end classifies before it gets
5961        // here, so this is the shape that would mean the classification went wrong.
5962        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5963            .expect_err("only two come back");
5964        assert_eq!(
5965            failed.to_string(),
5966            "what this function gives back takes more registers than this convention has for it"
5967        );
5968
5969        let inst = failed.inst().expect("the instruction it is about");
5970        assert_eq!(source[inst].opcode, Opcode::Return);
5971    }
5972
5973    /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
5974    ///
5975    /// Everything else is about something written somewhere in the body and hands it back so a
5976    /// caller can ask the function where it came from. A parameter arrives before the first
5977    /// instruction runs, so there is nothing in the body to point at and the message is about
5978    /// the function.
5979    #[test]
5980    fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
5981        let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
5982        assert_eq!(missing.inst(), None);
5983    }
5984
5985    /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
5986    fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
5987        let info = MemInfo { size, align, ..plain() };
5988        let mut build = Builder::new(source, block);
5989        let mem = build.func().add_mem(info);
5990        build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
5991    }
5992
5993    #[test]
5994    fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
5995        let (mut names, mut source, block, _) = blank(&[]);
5996        let slot = slot(&mut source, block, 4, 4);
5997        let mut build = Builder::new(&mut source, block);
5998        let nine = build.iconst(Type::int(32), 9);
5999        build.store(nine, slot, plain(), Flags::default());
6000        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
6001        build.ret(&[loaded]);
6002
6003        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6004            .expect("every instruction has a rule");
6005
6006        // Four bytes on the list the frame is laid out from, and the one instruction that reads
6007        // where they went. Its displacement is nothing here because there is no frame yet, and
6008        // which instruction is waiting for which local is what `finish` is handed.
6009        assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
6010        assert_eq!(lowered.stack.addresses.len(), 1);
6011        assert_eq!(lowered.stack.addresses[0].1, 0);
6012        assert_eq!(
6013            mir::print_func(&lowered.func, &names, &REGS),
6014            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [$rsp]\n    \
6015             %1:gpr = x64.mov_ri_32 9\n    x64.mov_mr_32 %1, [%0]\n    \
6016             %2:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %2($rax)\n}\n"
6017        );
6018    }
6019
6020    #[test]
6021    fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
6022        let (mut names, mut source, block, _) = blank(&[]);
6023        let scratch = slot(&mut source, block, 4, 4);
6024        let mut build = Builder::new(&mut source, block);
6025        let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
6026        let declared = build
6027            .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
6028        build.func().declare_mem(mem, 41);
6029        build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
6030        build.ret(&[]);
6031
6032        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6033            .expect("every instruction has a rule");
6034
6035        // Two locals and one declaration, held against the order the allocas were lowered in,
6036        // which is the only name a local has by the time the frame places it. The scratch one was
6037        // reached first and is local zero, so the declared one is local one.
6038        assert_eq!(lowered.stack.locals.len(), 2);
6039        assert_eq!(lowered.stack.declared, vec![(1, 41)]);
6040    }
6041
6042    /// A local the program kept in a value comes out saying which register holds it.
6043    ///
6044    /// The other half of the local above, which had a slot. This one has none, so what carries the
6045    /// declaration is the register the instruction computing it writes into.
6046    #[test]
6047    fn a_local_the_program_kept_in_a_value_says_which_register_holds_it() {
6048        let (mut names, mut source, block, _) = blank(&[]);
6049        let mut build = Builder::new(&mut source, block);
6050        let nine = build.iconst(Type::int(32), 9);
6051        let ten = build.iconst(Type::int(32), 10);
6052        let sum = build.binary(Opcode::Add, nine, ten, Flags::default());
6053        build.func().declare_value(sum, 41);
6054        build.ret(&[sum]);
6055
6056        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6057            .expect("every instruction has a rule");
6058
6059        // One pair and not three. The constants are values the program never declared, and a
6060        // register holding one of those is nobody's. The register is the one the addition writes,
6061        // which the listing under it is what pins down.
6062        assert_eq!(lowered.func.named, vec![(41, mir::Reg::virtual_reg(1))]);
6063        assert_eq!(
6064            mir::print_func(&lowered.func, &names, &REGS),
6065            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 9\n    \
6066             %1:gpr(reuse 1) = x64.add_ri_32 %0, 10\n    x64.ret_val_32 %1($rax)\n}\n"
6067        );
6068    }
6069
6070    /// A local held in a constant two blocks want is two registers and both of them are it.
6071    ///
6072    /// Why the declaration is written down as each register is handed out rather than once at the
6073    /// end over the map from values to registers. That map remembers the last register a value was
6074    /// written into, and a constant is written again in every block that wants one, so a local held
6075    /// in one would come out findable in the last block of the function and nowhere else.
6076    #[test]
6077    fn a_local_held_in_a_constant_two_blocks_want_is_named_in_both_of_them() {
6078        let i32 = Type::int(32);
6079        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
6080        let then = source.create_block();
6081        let other = source.create_block();
6082        let join = source.create_block();
6083        let got = source.append_param(join, i32);
6084
6085        let mut build = Builder::new(&mut source, entry);
6086        let seven = build.iconst(i32, 7);
6087        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
6088        build.func().declare_value(seven, 41);
6089        build.br_if(cond, then, &[], other, &[]);
6090        Builder::new(&mut source, then).jump(join, &[seven]);
6091        Builder::new(&mut source, other).jump(join, &[seven]);
6092        Builder::new(&mut source, join).ret(&[got]);
6093
6094        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6095            .expect("every instruction has a rule");
6096
6097        let held = &lowered.func.named;
6098        assert_eq!(held.len(), 2, "one register per block that wanted the seven: {held:?}");
6099        assert!(held.iter().all(|&(decl, _)| decl == 41), "{held:?}");
6100        assert_ne!(held[0].1, held[1].1, "the same register in two blocks: {held:?}");
6101    }
6102
6103    /// A parameter the program declared comes out named too, in the register it arrived in.
6104    ///
6105    /// The case the walk over the map at the end is for. A parameter is put in a register the
6106    /// convention chose rather than in a fresh one, so nothing asks the mint for it and the pair
6107    /// would otherwise never be written down.
6108    #[test]
6109    fn a_parameter_the_program_declared_says_which_register_it_arrived_in() {
6110        let i32 = Type::int(32);
6111        let (mut names, mut source, block, args) = blank(&[i32]);
6112        let mut build = Builder::new(&mut source, block);
6113        build.func().declare_value(args[0], 41);
6114        build.ret(&[args[0]]);
6115
6116        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6117            .expect("every instruction has a rule");
6118
6119        let held = &lowered.func.named;
6120        assert_eq!(held.len(), 1, "one pair for the one parameter: {held:?}");
6121        assert_eq!(held[0].0, 41);
6122    }
6123
6124    /// A function with nothing declared in it says nothing, which is every function compiled
6125    /// without debugging information asked for.
6126    #[test]
6127    fn a_function_the_front_end_named_nothing_in_names_no_registers() {
6128        let (mut names, mut source, block, _) = blank(&[]);
6129        let mut build = Builder::new(&mut source, block);
6130        let nine = build.iconst(Type::int(32), 9);
6131        build.ret(&[nine]);
6132
6133        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6134            .expect("every instruction has a rule");
6135        assert!(lowered.func.named.is_empty(), "{:?}", lowered.func.named);
6136    }
6137
6138    #[test]
6139    fn the_frame_is_what_fills_the_address_of_a_local_in() {
6140        let (mut names, mut source, block, _) = blank(&[]);
6141        let slot = slot(&mut source, block, 4, 4);
6142        let mut build = Builder::new(&mut source, block);
6143        let nine = build.iconst(Type::int(32), 9);
6144        build.store(nine, slot, plain(), Flags::default());
6145        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
6146        build.ret(&[loaded]);
6147
6148        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6149            .expect("every instruction has a rule");
6150        let stack = lowered.stack;
6151        let mut out = lowered.func;
6152        let env = env();
6153        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6154        let layout = stack.layout(Layout::new(&SYSV, REGS));
6155        let frame = Frame::of(&out, &allocation, &layout);
6156        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
6157
6158        // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
6159        // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
6160        // never moves and the four bytes are below it, which is what the negative offset is. The
6161        // instruction the lowering left with nothing in its displacement now has the answer in it.
6162        let text = mir::print_func(&out, &names, &REGS);
6163        assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
6164        assert!(!text.contains("x64.sub_ri_64"), "{text}");
6165        assert_eq!(frame.size(), 0);
6166        assert_eq!(frame.local(0), Some(-8));
6167    }
6168
6169    /// An `alloca` whose size is an operand, which is a variable length array.
6170    fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
6171        let info = MemInfo { size: 0, align, ..plain() };
6172        let mut build = Builder::new(source, block);
6173        let mem = build.func().add_mem(info);
6174        let args = build.func().push_values(&[size]);
6175        build.value(
6176            InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
6177            Type::PTR,
6178        )
6179    }
6180
6181    #[test]
6182    fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
6183        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
6184        let slot = growing(&mut source, block, args[0], 16);
6185        Builder::new(&mut source, block).ret(&[slot]);
6186
6187        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6188            .expect("every instruction has a rule");
6189
6190        // The bytes come off the stack pointer where the declaration stands and the address is
6191        // where the stack pointer then is, which is one subtraction and one `lea` rather than a
6192        // slot the frame laid out. Nothing is on the list of locals, because there is nothing
6193        // about this the frame could place.
6194        let text = mir::print_func(&lowered.func, &names, &REGS);
6195        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
6196        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
6197        assert!(lowered.stack.locals.is_empty(), "{text}");
6198        assert_eq!(lowered.stack.dynamic.len(), 1);
6199        assert!(lowered.stack.grown_at.is_some());
6200    }
6201
6202    #[test]
6203    fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
6204        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
6205        let slot = growing(&mut source, block, args[0], 32);
6206        Builder::new(&mut source, block).ret(&[slot]);
6207
6208        // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
6209        // for means masking the stack pointer after moving it, and after that no constant reaches
6210        // the rest of the frame from the frame pointer either. A second pointer held for the
6211        // purpose is what fixes it and there is not one yet.
6212        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6213            .expect_err("nothing realigns a frame that grows");
6214        assert_eq!(
6215            failed.to_string(),
6216            "this local wants more alignment than the stack pointer is left on, which needs a \
6217             base register nothing here keeps"
6218        );
6219    }
6220
6221    #[test]
6222    fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
6223        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
6224        let fixed = slot(&mut source, block, 4, 4);
6225        let mut build = Builder::new(&mut source, block);
6226        let nine = build.iconst(Type::int(32), 9);
6227        build.store(nine, fixed, plain(), Flags::default());
6228        let grown = growing(&mut source, block, args[0], 16);
6229        Builder::new(&mut source, block).ret(&[grown]);
6230
6231        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
6232            .expect("every instruction has a rule");
6233        let stack = lowered.stack;
6234        let mut out = lowered.func;
6235        let env = env();
6236        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6237        let layout = stack.layout(Layout::new(&SYSV, REGS));
6238        let frame = Frame::of(&out, &allocation, &layout);
6239        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
6240
6241        // The stack pointer moves in the middle of the function, so the four bytes of the fixed
6242        // local are not a constant away from it any more and the frame pointer is what reaches
6243        // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
6244        // living in the red zone, and the address of the growing slot is off the stack pointer as
6245        // it stands after the subtraction rather than off anything the prologue left.
6246        let text = mir::print_func(&out, &names, &REGS);
6247        assert!(frame.grows());
6248        assert!(frame.frame_pointer());
6249        assert!(frame.size() > 0, "{text}");
6250        assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
6251        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
6252        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
6253    }
6254
6255    #[test]
6256    fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
6257        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
6258        let mut build = Builder::new(&mut source, block);
6259        let stepped = build.func().push_values(&[args[0], args[1]]);
6260        let next =
6261            build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
6262        let loaded = build.load(Type::int(32), next, plain(), Flags::default());
6263        build.ret(&[loaded]);
6264
6265        // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
6266        // in the rule set, which is the point: the two addresses arrive in registers because an
6267        // address is an integer as wide as one, and the arithmetic on them is the add it always
6268        // was, so every rule written about an add reaches it.
6269        //
6270        // The add stays its own instruction here rather than folding into the address the load
6271        // reads from. Two registers with no scale on either is the one addressing mode the rules
6272        // have no load through, because the folds that exist are the displacement one and the
6273        // scaled ones, and this is neither. `crate::fold` is what puts the two together, after
6274        // selection, and this is the pair it is handed.
6275        assert_eq!(
6276            lower(&mut names, &source),
6277            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6278             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
6279             %3:gpr = x64.mov_rm_32 [%2]\n    x64.ret_val_32 %3($rax)\n}\n"
6280        );
6281    }
6282
6283    /// The address of a file scope name, which is what every use of a global and every string
6284    /// literal starts from.
6285    fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
6286        let symbol = names.intern(name);
6287        let mut build = Builder::new(source, block);
6288        build.value(
6289            InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
6290            Type::PTR,
6291        )
6292    }
6293
6294    #[test]
6295    fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
6296        let (mut names, mut source, block, _) = blank(&[]);
6297        let counter = address_of(&mut source, block, &mut names, "counter");
6298        let mut build = Builder::new(&mut source, block);
6299        let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
6300        build.ret(&[loaded]);
6301
6302        // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
6303        // that names no register and carries the symbol, which is what the assembler writes
6304        // relative to `%rip` and what the object writer leaves a relocation for.
6305        assert_eq!(
6306            lower(&mut names, &source),
6307            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [@counter]\n    \
6308             %1:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %1($rax)\n}\n"
6309        );
6310    }
6311
6312    #[test]
6313    fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
6314        let (mut names, mut source, block, _) = blank(&[]);
6315        let away = address_of(&mut source, block, &mut names, "away");
6316        Builder::new(&mut source, block).ret(&[away]);
6317        let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
6318
6319        // `extern void away(void); void *f(void) { return away; }`. A load and not an address
6320        // computation, because the distance from here to a name a shared library may be the one
6321        // that defines is not a number any link can work out, and the slot the linker fills in is
6322        // in this program and so is a distance it has.
6323        let out =
6324            func(&source, &mut names, &SYSV, &elsewhere).expect("every instruction has a rule");
6325        assert_eq!(
6326            mir::print_func(&out.func, &names, &REGS),
6327            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [got @away]\n    \
6328             x64.ret_val_64 %0($rax)\n}\n"
6329        );
6330    }
6331
6332    #[test]
6333    fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
6334        let (mut names, mut source, block, _) = blank(&[]);
6335        let own = address_of(&mut source, block, &mut names, "own");
6336        Builder::new(&mut source, block).ret(&[own]);
6337        let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
6338
6339        // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
6340        // the two cases above are one, because there is no address to load or to work out: the
6341        // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
6342        // thread's block starts, and the sum of the two is this thread's copy.
6343        let out =
6344            func(&source, &mut names, &SYSV, &elsewhere).expect("every instruction has a rule");
6345        assert_eq!(
6346            mir::print_func(&out.func, &names, &REGS),
6347            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [thread @own]\n    \
6348             %1:gpr = x64.mov_rm_64 [fs:0]\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
6349             x64.ret_val_64 %2($rax)\n}\n"
6350        );
6351    }
6352
6353    /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
6354    #[test]
6355    fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
6356        let (mut names, mut source, block, _) = blank(&[]);
6357        let here =
6358            Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
6359        Builder::new(&mut source, block).ret(&[here]);
6360
6361        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
6362            .expect("every instruction has a rule");
6363        assert_eq!(
6364            mir::print_func(&out.func, &names, &REGS),
6365            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
6366             x64.ret_val_64 %0($rax)\n}\n"
6367        );
6368    }
6369
6370    /// One `asm` statement, with its template and its constraint list written as a program does.
6371    fn assembly(
6372        source: &mut Func,
6373        block: Block,
6374        names: &mut Interner,
6375        template: &str,
6376        constraints: &str,
6377        args: &[Value],
6378        results: &[Type],
6379    ) -> Inst {
6380        clobbering(source, block, names, template, constraints, "memory", args, results)
6381    }
6382
6383    /// The same with a clobber list of its own, for the statements that are about one.
6384    #[allow(clippy::too_many_arguments)]
6385    fn clobbering(
6386        source: &mut Func,
6387        block: Block,
6388        names: &mut Interner,
6389        template: &str,
6390        constraints: &str,
6391        clobbers: &str,
6392        args: &[Value],
6393        results: &[Type],
6394    ) -> Inst {
6395        let info = AsmInfo {
6396            template: names.intern(template),
6397            constraints: names.intern(constraints),
6398            clobbers: names.intern(clobbers),
6399            targets: rucc_ir::BlockCallList::EMPTY,
6400        };
6401        Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
6402    }
6403
6404    /// What a program asking the processor what it can do writes, which is the instruction whose
6405    /// every operand is a register its text does not name.
6406    #[test]
6407    fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
6408        let u32 = Type::int(32);
6409        let (mut names, mut source, block, _) = blank(&[]);
6410        let zero = Builder::new(&mut source, block).iconst(u32, 0);
6411        let out = clobbering(
6412            &mut source,
6413            block,
6414            &mut names,
6415            "cpuid",
6416            "=a,a",
6417            "ebx,ecx,edx",
6418            &[zero],
6419            &[u32],
6420        );
6421        let produced = source[out].results().next().expect("one result");
6422        Builder::new(&mut source, block).ret(&[produced]);
6423
6424        // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
6425        // every program that has a faster path on some machines writes. Four registers written and
6426        // two read, none of them in the template, all of them out of the description, and the two
6427        // that the letters named are the statement's own. The subleaf is a zero because the
6428        // instruction reads `ecx` and the program said nothing about what is in it. The three
6429        // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
6430        // register with two definitions.
6431        assert_eq!(
6432            lower(&mut names, &source),
6433            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    \
6434             %1:gpr = x64.mov_ri_64 0\n    \
6435             %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
6436             %1($rcx)\n    x64.ret_val_32 %2($rax)\n}\n"
6437        );
6438    }
6439
6440    /// An operand the program pinned, by declaring the object it comes from `register long x asm
6441    /// ("r12")`. The letter on its own leaves the allocator to pick, and a template that reads the
6442    /// register by name needs the two to be the same register, so the brace is what ties them
6443    /// together. That is the one use of a local register variable the GNU manual calls reliable,
6444    /// and it is what tcc's `tests/tcctest.c` counts on.
6445    #[test]
6446    fn an_operand_the_program_pinned_is_placed_in_the_register_it_named() {
6447        let u64 = Type::int(64);
6448        let (mut names, mut source, block, _) = blank(&[]);
6449        let out =
6450            assembly(&mut source, block, &mut names, "mov $0x4542, %r12", "=r{r12}", &[], &[u64]);
6451        let produced = source[out].results().next().expect("one result");
6452        Builder::new(&mut source, block).ret(&[produced]);
6453
6454        // The template is one instruction the table already has, so it lowers to that instruction
6455        // rather than to text nobody read, and the register it names is the statement's own output
6456        // because the brace put the output there. Without the brace the letter would have let the
6457        // allocator pick, the two `%r12` would have been different registers, and the program would
6458        // have come back with whatever was in the one it picked.
6459        assert_eq!(
6460            lower(&mut names, &source),
6461            "mfunc @f {\nblock0:\n    %0:gpr($r12) = x64.mov_ri_64 17730\n    \
6462             x64.ret_val_64 %0($rax)\n}\n"
6463        );
6464    }
6465
6466    /// A clobber the instruction does not write itself, which is the case the list is there for.
6467    /// It goes on as a definition of the register, in among the other definitions, because that is
6468    /// the whole of how a machine function says a register is not worth anything after this.
6469    #[test]
6470    fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
6471        let (mut names, mut source, block, _) = blank(&[]);
6472        clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
6473        Builder::new(&mut source, block).ret(&[]);
6474
6475        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    $rsi = x64.pause\n}\n");
6476    }
6477
6478    /// A clobber naming something this has no register for. Refused rather than dropped, since the
6479    /// list is the program saying which registers it may not leave anything in, and an entry
6480    /// nobody read is a register something may still be left in.
6481    #[test]
6482    fn a_clobber_this_has_no_register_for_is_refused() {
6483        let (mut names, mut source, block, _) = blank(&[]);
6484        clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
6485        Builder::new(&mut source, block).ret(&[]);
6486
6487        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6488            .expect_err("there is no such register here");
6489        assert_eq!(
6490            failed.to_string(),
6491            "this `asm` says it destroys a register this has no name for"
6492        );
6493    }
6494
6495    #[test]
6496    fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
6497        let (mut names, mut source, block, _) = blank(&[]);
6498        assembly(&mut source, block, &mut names, "", "", &[], &[]);
6499        Builder::new(&mut source, block).ret(&[]);
6500
6501        // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
6502        // spent on the optimizer, which has finished by now, so what is left is nothing.
6503        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
6504    }
6505
6506    #[test]
6507    fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
6508        let i32 = Type::int(32);
6509        let (mut names, mut source, block, args) = blank(&[i32]);
6510        let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
6511        let produced = source[out].results().next().expect("one result");
6512        Builder::new(&mut source, block).ret(&[produced]);
6513
6514        // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
6515        // value without changing it. The two share a place and the template writes nothing over
6516        // it, so the value comes back out of the register it went in.
6517        assert_eq!(
6518            lower(&mut names, &source),
6519            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6520             x64.ret_val_32 %0($rax)\n}\n"
6521        );
6522    }
6523
6524    #[test]
6525    fn an_output_written_plus_is_the_same_rename() {
6526        let i32 = Type::int(32);
6527        let (mut names, mut source, block, args) = blank(&[i32]);
6528        let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
6529        let produced = source[out].results().next().expect("one result");
6530        Builder::new(&mut source, block).ret(&[produced]);
6531
6532        // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
6533        assert_eq!(
6534            lower(&mut names, &source),
6535            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6536             x64.ret_val_32 %0($rax)\n}\n"
6537        );
6538    }
6539
6540    #[test]
6541    fn an_output_nothing_is_tied_to_is_a_zero() {
6542        let i32 = Type::int(32);
6543        let (mut names, mut source, block, _) = blank(&[]);
6544        let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
6545        let produced = source[out].results().next().expect("one result");
6546        Builder::new(&mut source, block).ret(&[produced]);
6547
6548        // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
6549        // an empty template leaves nothing. A definite value rather than a register nothing wrote,
6550        // because the allocator is owed a definition before the use however little the program is.
6551        assert_eq!(
6552            lower(&mut names, &source),
6553            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
6554        );
6555    }
6556
6557    #[test]
6558    fn a_template_that_is_one_instruction_becomes_that_instruction() {
6559        let (mut names, mut source, block, _) = blank(&[]);
6560        assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
6561        Builder::new(&mut source, block).ret(&[]);
6562
6563        // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
6564        // instruction, no operands, and nothing between the template and the machine but the table
6565        // that already says what a `pause` is.
6566        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    x64.pause\n}\n");
6567    }
6568
6569    #[test]
6570    fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
6571        let i64 = Type::int(64);
6572        let (mut names, mut source, block, _) = blank(&[]);
6573        let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
6574        let produced = source[out].results().next().expect("one result");
6575        Builder::new(&mut source, block).ret(&[produced]);
6576
6577        // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
6578        // thread owns. The same instruction `crate::lower` already writes for a thread-local
6579        // variable, reached this time because a program wrote it out by hand.
6580        assert_eq!(
6581            lower(&mut names, &source),
6582            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
6583             x64.ret_val_64 %0($rax)\n}\n"
6584        );
6585    }
6586
6587    #[test]
6588    fn a_template_naming_an_instruction_this_machine_has_not_got_is_refused() {
6589        let (mut names, mut source, block, _) = blank(&[]);
6590        assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
6591        Builder::new(&mut source, block).ret(&[]);
6592
6593        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6594            .expect_err("there is no such instruction");
6595        assert_eq!(
6596            failed.to_string(),
6597            "this `asm` has instructions in its template, which nothing here assembles"
6598        );
6599    }
6600
6601    /// A register the template named is placed as itself, fixed to the register the program wrote
6602    /// down. A register a constraint letter names is a different thing and is placed too, which the
6603    /// test above is about: there the statement said which of its own operands is in the register,
6604    /// and a name in the middle of a template says the register and nothing about any operand.
6605    #[test]
6606    fn a_template_naming_a_register_gets_that_register() {
6607        let i64 = Type::int(64);
6608        let (mut names, mut source, block, _) = blank(&[]);
6609        let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
6610        let produced = source[out].results().next().expect("one result");
6611        Builder::new(&mut source, block).ret(&[produced]);
6612
6613        // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
6614        // The source is the register itself and the destination is one the allocator picks.
6615        assert_eq!(
6616            lower(&mut names, &source),
6617            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rax($rax)\n    \
6618             x64.ret_val_64 %0($rax)\n}\n"
6619        );
6620    }
6621
6622    /// The half of the same thing every register saving template needs. micropython writes the
6623    /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
6624    /// of that line are a register the template named: the one being stored and the one the address
6625    /// is counted from.
6626    #[test]
6627    fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
6628        let (mut names, mut source, block, _) = blank(&[]);
6629        assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
6630        Builder::new(&mut source, block).ret(&[]);
6631
6632        assert_eq!(
6633            lower(&mut names, &source),
6634            "mfunc @f {\nblock0:\n    x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
6635        );
6636    }
6637
6638    /// A local kept in a named register, which is the same register named as itself and reached
6639    /// from the other side. micropython's collector writes six of these and reads them with
6640    /// ordinary C rather than with a template.
6641    #[test]
6642    fn a_local_kept_in_a_named_register_is_one_move_out_of_it() {
6643        let (mut names, mut source, block, _) = blank(&[]);
6644        let held = names.intern("rbx");
6645        let value = Builder::new(&mut source, block).value(
6646            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
6647            Type::int(64),
6648        );
6649        Builder::new(&mut source, block).ret(&[value]);
6650
6651        assert_eq!(
6652            lower(&mut names, &source),
6653            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rbx($rbx)\n    \
6654             x64.ret_val_64 %0($rax)\n}\n"
6655        );
6656    }
6657
6658    /// The sigil gcc allows in front of the name is syntax and comes off, and a name that is not
6659    /// a register of this machine is refused in words that say which name it was.
6660    #[test]
6661    fn a_register_name_is_read_with_or_without_its_sigil_and_refused_when_there_is_no_such_one() {
6662        for written in ["%r12", "r12"] {
6663            let (mut names, mut source, block, _) = blank(&[]);
6664            let held = names.intern(written);
6665            let value = Builder::new(&mut source, block).value(
6666                InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
6667                Type::int(64),
6668            );
6669            Builder::new(&mut source, block).ret(&[value]);
6670            assert!(lower(&mut names, &source).contains("$r12($r12)"), "{written} is not read");
6671        }
6672
6673        let (mut names, mut source, block, _) = blank(&[]);
6674        let held = names.intern("nowhere");
6675        let value = Builder::new(&mut source, block).value(
6676            InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
6677            Type::int(64),
6678        );
6679        Builder::new(&mut source, block).ret(&[value]);
6680
6681        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6682            .expect_err("there is no such register");
6683        assert_eq!(
6684            failed.to_string(),
6685            "this object is kept in `nowhere`, which is not a register this machine has"
6686        );
6687    }
6688
6689    #[test]
6690    fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
6691        let i32 = Type::int(32);
6692        let (mut names, mut source, block, args) = blank(&[i32]);
6693        assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
6694        Builder::new(&mut source, block).ret(&[]);
6695
6696        // An output with no result to be, which is what the front end never writes and what a
6697        // hand written module can. Refused rather than placed by a guess.
6698        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6699            .expect_err("the list and the instruction disagree");
6700        assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
6701    }
6702
6703    /// A cast between a pointer and an integer, at whatever width the result is asked for.
6704    fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
6705        let mut build = Builder::new(source, block);
6706        let args = build.func().push_values(&[from]);
6707        build.value(InstData { args, ..InstData::new(opcode) }, to)
6708    }
6709
6710    #[test]
6711    fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
6712        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6713        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
6714        Builder::new(&mut source, block).ret(&[number]);
6715
6716        // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
6717        // as the machine addresses, so the cast changes what the type system calls the value and
6718        // changes nothing about the value, and the register holding it is the one that held it.
6719        assert_eq!(
6720            lower(&mut names, &source),
6721            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6722             x64.ret_val_64 %0($rax)\n}\n"
6723        );
6724    }
6725
6726    #[test]
6727    fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
6728        let (mut names, mut source, block, _) = blank(&[]);
6729        let mut build = Builder::new(&mut source, block);
6730        let zero = build.iconst(Type::int(64), 0);
6731        let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
6732        Builder::new(&mut source, block).ret(&[null]);
6733
6734        // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
6735        // writes the zero down: a constant is materialized where it is wanted rather than where
6736        // the IR defined it, and without the read there would be no instruction at all.
6737        assert_eq!(
6738            lower(&mut names, &source),
6739            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_64 0\n    x64.ret_val_64 %0($rax)\n}\n"
6740        );
6741    }
6742
6743    #[test]
6744    fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
6745        let readings = [
6746            (Linkage::External, mir::Binding::Global),
6747            (Linkage::Common, mir::Binding::Global),
6748            (Linkage::Internal, mir::Binding::Local),
6749            (Linkage::Weak, mir::Binding::Weak),
6750            (Linkage::LinkOnce, mir::Binding::Weak),
6751        ];
6752        for (linkage, wanted) in readings {
6753            let (mut names, mut source, block, _) = blank(&[]);
6754            source.linkage = linkage;
6755            Builder::new(&mut source, block).ret(&[]);
6756            let out = func(&source, &mut names, &SYSV, &Elsewhere::default()).expect("a return");
6757            // The narrowing is done here rather than where the object is written, because a
6758            // machine function is all the assembler and the writer are ever handed.
6759            assert_eq!(out.func.binding, wanted, "{linkage:?}");
6760        }
6761    }
6762
6763    /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
6764    /// three of them.
6765    ///
6766    /// Here for the reason the linkage above is here. A machine function is the whole of what the
6767    /// assembler and the object writer are handed, so a fact about the symbol that does not get
6768    /// onto one is a fact that is gone by the time anything could write it down, and the way that
6769    /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
6770    #[test]
6771    fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
6772        let readings = [
6773            (Visibility::Default, mir::Visibility::Default),
6774            (Visibility::Hidden, mir::Visibility::Hidden),
6775            (Visibility::Protected, mir::Visibility::Protected),
6776        ];
6777        for (visibility, wanted) in readings {
6778            let (mut names, mut source, block, _) = blank(&[]);
6779            source.visibility = visibility;
6780            Builder::new(&mut source, block).ret(&[]);
6781            let out = func(&source, &mut names, &SYSV, &Elsewhere::default()).expect("a return");
6782            assert_eq!(out.func.visibility, wanted, "{visibility:?}");
6783        }
6784    }
6785
6786    #[test]
6787    fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
6788        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6789        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
6790        Builder::new(&mut source, block).ret(&[number]);
6791
6792        // The front end never writes one: it casts at the address width and truncates or extends
6793        // around it, so both of those are the rules they always were. IR from somewhere else that
6794        // does write one is refused rather than compiled to a move that keeps the high half.
6795        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6796            .expect_err("no rule narrows an address");
6797        assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
6798    }
6799
6800    /// The type this machine has no register for.
6801    fn long_double() -> Type {
6802        Type::float(rucc_ir::Float::F80)
6803    }
6804
6805    #[test]
6806    fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
6807        let f64 = Type::float(rucc_ir::Float::F64);
6808        let (mut names, mut source, block, args) = blank(&[f64]);
6809        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6810        let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6811        Builder::new(&mut source, block).ret(&[back]);
6812
6813        // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
6814        // else, so the value is written to the crossing slot, loaded at the format that widens it
6815        // and put in the slot the eighty bit value lives in. Coming back is the same three the
6816        // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
6817        // every address in a frame looks like here until `finish` has the numbers.
6818        assert_eq!(
6819            lower(&mut names, &source),
6820            "mfunc @f {\nblock0:\n    \
6821             %0:xmm($xmm0) = x64.arg_val_f64\n    \
6822             %1:gpr = x64.lea_64 [$rsp]\n    \
6823             %2:gpr = x64.lea_64 [$rsp]\n    \
6824             x64.movsd_mr %0, [%1]\n    \
6825             x64.fld_l [%1]\n    \
6826             x64.fstp_t [%2]\n    \
6827             %3:gpr = x64.lea_64 [$rsp]\n    \
6828             %4:gpr = x64.lea_64 [$rsp]\n    \
6829             x64.fld_t [%3]\n    \
6830             x64.fstp_l [%4]\n    \
6831             %5:xmm = x64.movsd_rm [%4]\n    \
6832             x64.ret_val_f64 %5($xmm0)\n}\n"
6833        );
6834    }
6835
6836    #[test]
6837    fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
6838        let f64 = Type::float(rucc_ir::Float::F64);
6839        let (mut names, mut source, block, args) = blank(&[f64]);
6840        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6841        let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6842        let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6843        let mut build = Builder::new(&mut source, block);
6844        let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
6845        build.ret(&[sum]);
6846
6847        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
6848            .expect("every instruction is written");
6849
6850        // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
6851        // psABI says one takes and is aligned to, and eight for the crossing, which every group
6852        // in the function shares because nothing is ever left in it. The value's slot is its own
6853        // for the whole function, so reading it twice reads the same sixteen bytes.
6854        assert_eq!(
6855            out.stack.locals,
6856            vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
6857        );
6858    }
6859
6860    #[test]
6861    fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
6862        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
6863        let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
6864        let back =
6865            cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
6866        Builder::new(&mut source, block).ret(&[back]);
6867
6868        // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
6869        // format, so the conversion is the load and there is no instruction that converts.
6870        let text = lower(&mut names, &source);
6871        assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
6872        assert!(text.contains("x64.fild_ll [%1]"), "{text}");
6873    }
6874
6875    #[test]
6876    fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
6877        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
6878        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6879        let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
6880        Builder::new(&mut source, block).ret(&[whole]);
6881
6882        // The one conversion here with no single instruction behind it. C cuts towards zero and
6883        // the unit rounds the way its control word says, so the word is saved, ORed with the two
6884        // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
6885        // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
6886        let text = lower(&mut names, &source);
6887        let group: Vec<&str> = text
6888            .lines()
6889            .map(str::trim)
6890            .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
6891            .collect();
6892        assert_eq!(
6893            group,
6894            [
6895                "x64.fld_l [%1]",
6896                "x64.fstp_t [%2]",
6897                "x64.fnstcw [%5]",
6898                "%6:gpr = x64.mov_rm_16 [%5]",
6899                "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
6900                "x64.mov_mr_16 %7, [%5 + 2]",
6901                "x64.fldcw [%5 + 2]",
6902                "x64.fld_t [%3]",
6903                "x64.fistp_l [%4]",
6904                "x64.fldcw [%5]",
6905            ],
6906            "{text}"
6907        );
6908    }
6909
6910    #[test]
6911    fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
6912        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
6913        let mut build = Builder::new(&mut source, block);
6914        let value = build.load(long_double(), args[0], plain(), Flags::default());
6915        build.store(value, args[1], plain(), Flags::default());
6916        build.ret(&[]);
6917
6918        // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
6919        // format the value is already in, which neither converts nor looks: a signalling NaN stays
6920        // one and nothing is raised, which is the whole of what makes it a copy.
6921        let text = lower(&mut names, &source);
6922        let group: Vec<&str> =
6923            text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
6924        assert_eq!(
6925            group,
6926            ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
6927            "{text}"
6928        );
6929    }
6930
6931    /// Two `long double` values, from two `double` parameters, and the instructions that made
6932    /// them, which every test below this one throws away.
6933    fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
6934        let left = cast(source, block, Opcode::FPExt, args[0], long_double());
6935        let right = cast(source, block, Opcode::FPExt, args[1], long_double());
6936        (left, right)
6937    }
6938
6939    /// The x87 instructions of a function, in order, with everything else dropped.
6940    fn stack_only(text: &str) -> Vec<&str> {
6941        text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
6942    }
6943
6944    /// The two frame slots the last two addresses of a function were taken of, which in a
6945    /// comparison are the two operands in the order they go on the stack.
6946    fn pushed(out: &Lowered) -> Vec<usize> {
6947        let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
6948        taken[taken.len() - 2..].to_vec()
6949    }
6950
6951    #[test]
6952    fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
6953        let f64 = Type::float(rucc_ir::Float::F64);
6954        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6955        let (left, right) = two_long_doubles(&mut source, block, &args);
6956        let sum =
6957            Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
6958        let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
6959        Builder::new(&mut source, block).ret(&[back]);
6960
6961        // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
6962        // four lines are the add: both operands pushed, the instruction that names neither of
6963        // them because they are the top two of a stack, and the answer taken off into its slot.
6964        let text = lower(&mut names, &source);
6965        assert_eq!(
6966            stack_only(&text),
6967            [
6968                "x64.fld_l [%2]",
6969                "x64.fstp_t [%3]",
6970                "x64.fld_l [%4]",
6971                "x64.fstp_t [%5]",
6972                "x64.fld_t [%6]",
6973                "x64.fld_t [%7]",
6974                "x64.fadd_p",
6975                "x64.fstp_t [%8]",
6976                "x64.fld_t [%9]",
6977                "x64.fstp_l [%10]",
6978            ],
6979            "{text}"
6980        );
6981    }
6982
6983    #[test]
6984    fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
6985        let f64 = Type::float(rucc_ir::Float::F64);
6986        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6987        let (left, right) = two_long_doubles(&mut source, block, &args);
6988        let less =
6989            Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
6990        let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
6991        Builder::new(&mut source, block).ret(&[back]);
6992
6993        // The left one goes on first, so it ends up under the right one, and the answer wanted is
6994        // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
6995        // and computes the other one. The `r` says which spelling this is and not which order the
6996        // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
6997        // name is what got this wrong the first time.
6998        let text = lower(&mut names, &source);
6999        assert_eq!(
7000            &stack_only(&text)[4..8],
7001            ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
7002            "{text}"
7003        );
7004    }
7005
7006    #[test]
7007    fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
7008        let f64 = Type::float(rucc_ir::Float::F64);
7009        let (mut names, mut source, block, args) = blank(&[f64]);
7010        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
7011        let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
7012        let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
7013        Builder::new(&mut source, block).ret(&[back]);
7014
7015        // `fchs` and not a subtraction from zero, which would give a different answer at a negative
7016        // zero and would signal at a NaN. It does not read the value as a number at all.
7017        let text = lower(&mut names, &source);
7018        assert_eq!(
7019            &stack_only(&text)[2..5],
7020            ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
7021            "{text}"
7022        );
7023    }
7024
7025    #[test]
7026    fn comparing_two_long_doubles_puts_the_left_one_on_top() {
7027        let f64 = Type::float(rucc_ir::Float::F64);
7028        let (mut names, mut source, block, args) = blank(&[f64, f64]);
7029        let (left, right) = two_long_doubles(&mut source, block, &args);
7030        let mut build = Builder::new(&mut source, block);
7031        build.fcmp(FloatPred::Ogt, left, right, Flags::default());
7032        build.ret(&[]);
7033
7034        // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
7035        // operand the predicate is about has to go on last, which is the other way round from the
7036        // arithmetic above. The pop that clears the loser and the byte that reads the flags are
7037        // both inside the one opcode.
7038        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
7039            .expect("every instruction is written");
7040        let slots = pushed(&out);
7041        assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
7042        let text = mir::print_func(&out.func, &names, &REGS);
7043        assert_eq!(
7044            &stack_only(&text)[4..],
7045            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
7046            "{text}"
7047        );
7048    }
7049
7050    #[test]
7051    fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
7052        let f64 = Type::float(rucc_ir::Float::F64);
7053        let (mut names, mut source, block, args) = blank(&[f64, f64]);
7054        let (left, right) = two_long_doubles(&mut source, block, &args);
7055        let mut build = Builder::new(&mut source, block);
7056        build.fcmp(FloatPred::Olt, left, right, Flags::default());
7057        build.ret(&[]);
7058
7059        // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
7060        // the operands the other way round. The same trade the vector rules make, and it has to
7061        // be the same one: a `long double` comparison that picked a different condition from the
7062        // `double` comparison of the same two numbers would be wrong at exactly the unordered
7063        // cases the two conditions differ on.
7064        //
7065        // Which slot each push names is the whole of the difference from the test above, and the
7066        // text does not show it, since an address in a frame is a `lea` with nothing in it until
7067        // `finish` has the numbers. So the slots are what is read here.
7068        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
7069            .expect("every instruction is written");
7070        let slots = pushed(&out);
7071        assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
7072        let text = mir::print_func(&out.func, &names, &REGS);
7073        assert_eq!(
7074            &stack_only(&text)[4..],
7075            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
7076            "{text}"
7077        );
7078    }
7079
7080    #[test]
7081    fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
7082        let f64 = Type::float(rucc_ir::Float::F64);
7083        let (mut names, mut source, block, args) = blank(&[f64, f64]);
7084        let (left, right) = two_long_doubles(&mut source, block, &args);
7085        let mut build = Builder::new(&mut source, block);
7086        build.fcmp(FloatPred::Oeq, left, right, Flags::default());
7087        build.ret(&[]);
7088
7089        // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
7090        // second register as well as the one the value is in and ANDs them together. Said here by
7091        // handing it a spare, since an instruction that wrote a register nothing knew about would
7092        // be an instruction the allocator could put a live value in the way of.
7093        let text = lower(&mut names, &source);
7094        assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
7095    }
7096
7097    #[test]
7098    fn a_comparison_that_is_never_asked_is_reported() {
7099        let f64 = Type::float(rucc_ir::Float::F64);
7100        let (mut names, mut source, block, args) = blank(&[f64, f64]);
7101        let (left, right) = two_long_doubles(&mut source, block, &args);
7102        let mut build = Builder::new(&mut source, block);
7103        build.fcmp(FloatPred::False, left, right, Flags::default());
7104        build.ret(&[]);
7105
7106        // Always false is a constant and not a comparison, so there is no condition to pick and
7107        // nothing here folds it into one: an instruction that quietly agreed with it would hide
7108        // that the optimizer left a comparison in that it should have taken out.
7109        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
7110            .expect_err("no condition is always false");
7111        assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
7112    }
7113
7114    #[test]
7115    fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
7116        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
7117        let mut build = Builder::new(&mut source, block);
7118        // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
7119        let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
7120        build.store(one_and_a_half, args[0], plain(), Flags::default());
7121        build.ret(&[]);
7122
7123        // No x87 instruction at all. A slot holding one of these is the value, so a constant is
7124        // its ten bytes written where the value lives, and whatever reads it does the `fld`.
7125        let text = lower(&mut names, &source);
7126        assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
7127        assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
7128        assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
7129        // The six bytes above the ten are the padding that makes the type sixteen wide, and they
7130        // are unspecified rather than zero, so nothing writes them.
7131        assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
7132    }
7133
7134    #[test]
7135    fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
7136        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
7137        let mut build = Builder::new(&mut source, block);
7138        let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
7139        build.store(minus, args[0], plain(), Flags::default());
7140        build.ret(&[]);
7141
7142        // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
7143        // in a register with is above the signed range of sixteen bits and has to stay there: read
7144        // as a number it would be negative, and it is not a number, it is two bytes.
7145        let text = lower(&mut names, &source);
7146        assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
7147    }
7148
7149    #[test]
7150    fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
7151        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
7152        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
7153        let next = source.create_block();
7154        let param = source.append_param(next, long_double());
7155        Builder::new(&mut source, block).jump(next, &[wide]);
7156        Builder::new(&mut source, next).ret(&[param]);
7157
7158        // What the edge carries is the address of the slot the value is already in, which is an
7159        // ordinary register the allocator has an opinion about. The block on the other side copies
7160        // the sixteen bytes into a slot of its own before anything reads them, so a second edge
7161        // handing over a second address would still leave one place for a reader to look.
7162        let text = lower(&mut names, &source);
7163        let second: Vec<&str> = text
7164            .lines()
7165            .skip_while(|line| !line.starts_with("block1"))
7166            .skip(1)
7167            .take(3)
7168            .map(str::trim)
7169            .collect();
7170        assert_eq!(
7171            second,
7172            ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
7173            "{text}"
7174        );
7175    }
7176
7177    #[test]
7178    fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
7179        let f64 = Type::float(rucc_ir::Float::F64);
7180        let (mut names, mut source, block, args) = blank(&[f64]);
7181        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
7182        let next = source.create_block();
7183        let params: Vec<Value> =
7184            (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
7185        let carried: Vec<Value> = params.iter().map(|_| wide).collect();
7186        Builder::new(&mut source, block).jump(next, &carried);
7187        Builder::new(&mut source, next).ret(&[params[0]]);
7188
7189        // The copies go through the x87 stack so that every one of them is read before any of them
7190        // is written, which is what makes a block that swaps two of these right. Nine of them do
7191        // not fit on the stack, and copying the ninth before or after the rest is the order that
7192        // could be wrong, so it is refused instead.
7193        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
7194            .expect_err("nine do not fit on the stack");
7195        assert_eq!(
7196            failed.to_string(),
7197            "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
7198        );
7199        assert_eq!(failed.inst(), None);
7200    }
7201}