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 many bytes a `long double` takes in memory, and what it is aligned to, which are the same
122/// number and are both more than the ten bytes that mean anything.
123///
124/// The psABI's answer rather than a choice here. `sizeof (long double)` is sixteen on this
125/// machine, so an array of them is laid out this way whatever a slot holding one does, and a slot
126/// that agreed with the array is one fewer thing to get wrong.
127const X87_BYTES: u32 = 16;
128
129/// How many values the x87 stack holds at once.
130///
131/// Eight, which is the machine's number rather than a choice here, and it matters in one place:
132/// the parameters of a block are copied through the stack so that they all move at once, and a
133/// block with more of them than this has nowhere to put the ninth.
134const X87_DEPTH: usize = 8;
135
136/// How far into the buffer of a `__builtin_setjmp` each of the four words it writes is.
137///
138/// The first three are gcc's, measured against gcc 16.2.0 on x86-64 at `-O0`: the frame pointer,
139/// the address control comes back to, and the stack pointer, in that order. The fourth is this
140/// compiler's own. gcc has no word for the answer because it writes a second block that sets the
141/// answer to one and is arrived at from the restore, and this writes the answer through memory
142/// instead, for the reason [`Lowering::saves_place`] gives.
143///
144/// None of the four is an interface. The buffer is the program's memory and its five words are
145/// the front end's promise about how much of it there is, but nothing except the matching restore
146/// ever reads a word of it, and a buffer written by one compiler was never going to be one another
147/// compiler could come back through.
148const JUMP_FRAME: i32 = 0;
149
150/// Where the address control comes back to is. See [`JUMP_FRAME`].
151const JUMP_PC: i32 = 8;
152
153/// Where the stack pointer is. See [`JUMP_FRAME`].
154const JUMP_STACK: i32 = 16;
155
156/// Where the address of the word the answer arrives in is. See [`JUMP_FRAME`].
157const JUMP_ANSWER: i32 = 24;
158
159/// How many bytes the word a `__builtin_setjmp` answers with takes in the frame, and what it is
160/// aligned to, which are the same number because it is one machine word.
161const JUMP_WORD: u32 = 8;
162
163/// How many registers the restore needs to hold things in while it puts the frame back.
164///
165/// Four, and every one of them is a register nothing else in the function may be in, which is why
166/// they are counted here rather than asked for one at a time. See [`Lowering::comes_back`].
167const JUMP_REGS: usize = 4;
168
169/// How many bytes a value passes through on its way between a register and the x87 stack.
170///
171/// Eight, because the widest thing that crosses is a `double` or a sixty four bit integer, and
172/// nothing crosses at eighty bits: a value that wide is already in the frame and the stack reaches
173/// it where it is.
174const X87_CROSSING: u32 = 8;
175
176/// Where the rounding field of the x87 control word is and what it has to be set to for the unit
177/// to cut towards zero, which is the one rounding C asks for that the unit does not do by default.
178///
179/// Both bits on is truncate. The field is ORed into the word that was already there rather than
180/// written over it, so the precision control and the exception masks somebody else set stay set.
181const X87_TRUNCATE: i64 = 0x0c00;
182
183/// Whether a type is the one this machine has no register for.
184///
185/// Only the eighty bit float is, and that is a fact about x86-64 rather than about floats: every
186/// other scalar the front end produces is in a general purpose register or a vector one, and this
187/// one is on the x87 stack while it is being worked on and in memory the rest of the time. So it
188/// has no place in [`Lowering::class_of`] and no name in [`crate::term`], and every instruction
189/// that touches one is written out by hand in this file.
190fn on_x87(ty: Type) -> bool {
191    ty.is_scalar() && ty.is_float() && ty.bits() == 80
192}
193
194/// Where one operand of an assembly statement is, on each side of the assembly.
195///
196/// Two registers rather than one, because an operand written `+` is a value that arrives and a
197/// value that leaves and those are two values. The machine IR has one definition per register by
198/// construction, so an instruction of the template that reads the operand and writes it has to name
199/// a different register in each place, and what makes the two one register in the end is the
200/// [`Constraint::Reuse`] the instruction's description carries: the allocator reads it, gives both
201/// the same physical register, and copies the incoming value somewhere first when something else is
202/// still using it.
203///
204/// Most operands have one of the two. An input has only a place it is read from and an output
205/// written `=` has only a place it is written to, and asking either of them for the other is an
206/// operand read where the opcode writes or written where it reads, which [`Lowering::placed`]
207/// refuses.
208#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
209struct Place {
210    /// The register the value arrives in, for an operand something reads.
211    read: Option<mir::Reg>,
212    /// The register the value leaves in, for an operand something writes.
213    write: Option<mir::Reg>,
214}
215
216/// Whether that operand of the statement is one the assembly may read, and so where a read of it
217/// gets its value from.
218///
219/// [`bound`] asks this question of an operand a constraint letter named and this asks it of one the
220/// template numbered, which is the same question twice because a two-address instruction reaches
221/// its first source both ways. `mulq %3` reaches `rax` by the letter on the output and libgmp says
222/// what is in it with `"%0"` on an input. `addq %5,%q1` reaches its first source by numbering the
223/// output, and libgmp says what is in it with `"0"` on an input in the same way.
224///
225/// So an output written `=` has no value of its own and is still readable when an input is tied to
226/// it, and the value the read wants is that input's. An output written `+` carries its own value
227/// and answers with that. An output nothing is tied to answers `None`, which is a program that told
228/// the compiler the assembly only writes the operand while the instruction reads it before it
229/// writes it, and is refused where it is asked.
230fn read_as(list: &[AsmOperand], index: usize) -> Option<Value> {
231    let operand = list.get(index)?;
232    if operand.value.is_some() {
233        return operand.value;
234    }
235    operand.result?;
236    list.iter().find(|entry| entry.tied == Some(index)).and_then(|entry| entry.value)
237}
238
239/// Which of an assembly statement's operands is in that register, for an instruction that reaches
240/// the register without its text saying so.
241///
242/// The constraint letter is what says so, and it is the only thing in such a statement that could:
243/// `"=a"` is an output in `rax` and `"c"` is an input in `rcx`, and a register nothing names is a
244/// register nobody has said anything about. So a write looks among the outputs and a read among the
245/// inputs, and an output written `+` answers for either, since it is read before it is written.
246///
247/// The other way a read of such a register is said is a matching constraint. `"=a"` on an output
248/// and `"0"` on an input is the program saying that one register holds the input on the way in and
249/// the output on the way out, and it is how a statement fills a register the instruction reads and
250/// writes without writing the register down twice. The letter is on the output, which has no value
251/// to read, and the value is on the input, which has no letter, so neither of them answers this on
252/// its own and the answer is the input: what a read wants is the register the value arrived in, and
253/// that is the input's place.
254///
255/// `None` is a register the instruction uses and the statement put nothing in, which is the usual
256/// answer rather than an unusual one. `cpuid` writes four registers and a program that wanted one
257/// of them names one. See [`Lowering::spare`], which is where that one goes.
258fn bound(list: &[AsmOperand], reg: PhysReg, role: Role) -> Option<usize> {
259    let letter = |operand: &AsmOperand| operand.fixed.and_then(x86_64::gpr_letter);
260    let named = list.iter().position(|operand| {
261        letter(operand) == Some(reg)
262            && if role.is_def() { operand.result.is_some() } else { operand.value.is_some() }
263    });
264    if named.is_some() || role.is_def() {
265        return named;
266    }
267    list.iter().position(|operand| {
268        operand.value.is_some()
269            && operand
270                .tied
271                .is_some_and(|at| list.get(at).is_some_and(|out| letter(out) == Some(reg)))
272    })
273}
274
275/// Why a function could not be lowered.
276///
277/// One reason and then nothing. A function with no rule for something in it is a function this
278/// cannot finish, and the second thing it could not lower is not news.
279#[derive(Debug, Clone, PartialEq, Eq)]
280pub enum Unsupported {
281    /// An instruction no rule fires on.
282    Inst {
283        /// The instruction that stopped it.
284        inst: Inst,
285        /// What the rule file would call it, or nothing if the rule language has no name for it
286        /// at all, which is what an instruction at a width nothing is written about looks like.
287        term: Option<&'static str>,
288        /// The opcode, which is what gets named when the rule language has no word for it.
289        ///
290        /// An opcode the rule language has no word for is exactly the opcode no rule lowers, so
291        /// without this the message would be empty in every case where somebody needs it.
292        opcode: Opcode,
293        /// What it produces, or nothing for an instruction that is only an effect.
294        ty: Option<Type>,
295    },
296    /// A parameter that does not arrive somewhere this can bring it in from.
297    ///
298    /// Not an instruction, which is why it is a separate arm: it is a fact about the signature
299    /// and there is nothing in the body of the function to point at.
300    Argument {
301        /// Its position in the signature.
302        index: usize,
303        /// What is wrong with where it arrives.
304        missing: Missing,
305    },
306    /// A call that passes or gives back a value this cannot put where the convention wants it.
307    Call {
308        /// The call.
309        inst: Inst,
310        /// Which value, and what is wrong with where it travels.
311        refused: Refused,
312    },
313    /// A `return` this cannot put where the convention wants it.
314    ///
315    /// A separate arm from [`Unsupported::Inst`] because it is not an instruction no rule fires
316    /// on. A return of more than one value is built from the convention rather than matched, the
317    /// same way a call is, so what goes wrong with one is what goes wrong with a call and not the
318    /// absence of a rule.
319    Returned {
320        /// The `return`.
321        inst: Inst,
322        /// What is wrong with where one of the values travels.
323        missing: Missing,
324    },
325    /// A stack slot the frame cannot give the bytes it asked for.
326    ///
327    /// Not an instruction no rule covers. An `alloca` is built here rather than matched, so what
328    /// goes wrong with one is what the frame can and cannot hold rather than what the rules spell.
329    Dynamic {
330        /// The `alloca`.
331        inst: Inst,
332        /// What the frame could not do about it.
333        growing: Growing,
334    },
335    /// More parameters of a type that travels on the x87 stack than the stack is deep.
336    ///
337    /// Not an instruction either, for the reason a function's parameter is not one: it is a fact
338    /// about the block and there is nothing in the block to point at. What crosses an edge for one
339    /// of these is the address of where the value is, and the block copies the bytes into a slot
340    /// of its own, all of them through the stack at once so that a block carrying two of them
341    /// swapped is copied in an order that is right. Eight is as many as the stack holds, and a
342    /// ninth would have to be copied before or after the rest, which is the order that could be
343    /// wrong.
344    Phi {
345        /// Which block it arrives at.
346        block: Block,
347        /// How many of them arrive there, which is the whole of what is wrong.
348        count: usize,
349        /// What they are.
350        ty: Type,
351    },
352    /// An `asm` statement this cannot build.
353    ///
354    /// Not an instruction no rule fires on, for the reason a call is not one: what it stands for is
355    /// whatever its template says, and no pattern over terms can read a string.
356    Assembly {
357        /// The `inline_asm`.
358        inst: Inst,
359        /// What about it is not built here yet.
360        refused: Written,
361    },
362    /// A naked function whose frame is not empty.
363    ///
364    /// Not an instruction no rule fires on, and there is nothing in the body to point at: the
365    /// function asked for no prologue and then wanted bytes only a prologue takes. Refused rather
366    /// than given the bytes anyway, because an offset into a frame nothing set up reaches into
367    /// whatever the caller left below its own stack pointer, which is wrong code that assembles.
368    /// See [`crate::frame::Layout::naked`].
369    Naked {
370        /// How many bytes it wanted, which is the whole of what is wrong.
371        bytes: u32,
372    },
373}
374
375/// What about an `asm` statement is not built yet.
376#[derive(Debug, Clone, Copy, PartialEq, Eq)]
377pub enum Written {
378    /// A template with instructions in it.
379    Template,
380    /// An `asm goto`, whose labels make the statement a terminator.
381    Goto,
382    /// An operand this cannot put where the constraint says it goes.
383    Operand,
384    /// A clobber list naming something this has no register for.
385    Clobber,
386    /// A `jmp` out of the function in a function that has an epilogue behind it.
387    Away,
388}
389
390impl Written {
391    /// The rest of the sentence that starts with the statement.
392    #[must_use]
393    pub fn why(self) -> &'static str {
394        match self {
395            // The template is the assembler's to read and there is no assembler here yet, so a
396            // template with anything in it is a string nothing can turn into bytes. An empty one is
397            // no instructions, and no instructions is something this can write.
398            Written::Template => "has instructions in its template, which nothing here assembles",
399            Written::Goto => "jumps to a label, which nothing here builds an edge for",
400            Written::Operand => "has an operand this cannot place",
401            Written::Clobber => "says it destroys a register this has no name for",
402            Written::Away => {
403                "jumps out of the function, which only a function that is `naked` may do, since \
404                 anywhere else there is an epilogue behind it to give the frame back"
405            }
406        }
407    }
408}
409
410/// What the frame could not do about a stack slot.
411#[derive(Debug, Clone, Copy, PartialEq, Eq)]
412pub enum Growing {
413    /// An object of a size the number a frame counts bytes in does not reach.
414    Huge,
415    /// A variable length array wanting more alignment than a call leaves the stack pointer with.
416    ///
417    /// Rounding the stack pointer down again after the bytes have been taken would put it
418    /// somewhere no constant reaches the rest of the frame from, so a frame like this needs a
419    /// second base register held for the whole of the function. Nothing here holds one.
420    ///
421    /// [`crate::expand::rounds`] takes the array away before this sees it, by asking for the
422    /// alignment in extra bytes and handing out an address inside them, so what is left of this
423    /// is IR that arrived without going through that pass and the fixed local in
424    /// [`crate::pipeline`] that wants the same thing from the other side.
425    Aligned,
426    /// A variable length array in a function written without a prologue.
427    ///
428    /// A frame that grows is reached from a frame pointer, and establishing one is the first two
429    /// instructions of a prologue that `__attribute__((naked))` asked there be none of. See
430    /// [`crate::frame::Layout::naked`].
431    Naked,
432}
433
434impl Growing {
435    /// The rest of the sentence that starts with the slot.
436    #[must_use]
437    pub fn why(self) -> &'static str {
438        match self {
439            Growing::Huge => "is more bytes than a frame counts",
440            Growing::Aligned => {
441                "wants more alignment than the stack pointer is left on, which needs a base \
442                 register nothing here keeps"
443            }
444            Growing::Naked => {
445                "is in a function that is `naked`, which has no prologue to point a frame pointer \
446                 at it with"
447            }
448        }
449    }
450}
451
452impl Unsupported {
453    /// The instruction it is about, or nothing for the one arm that is about a signature.
454    ///
455    /// What a caller wants this for is the span. The function knows where every instruction in
456    /// it came from, so a caller holding both can point a message at the line somebody wrote
457    /// rather than at the file as a whole, and nothing here has to carry a span of its own.
458    pub fn inst(&self) -> Option<Inst> {
459        match *self {
460            Unsupported::Inst { inst, .. }
461            | Unsupported::Call { inst, .. }
462            | Unsupported::Returned { inst, .. }
463            | Unsupported::Dynamic { inst, .. }
464            | Unsupported::Assembly { inst, .. } => Some(inst),
465            Unsupported::Argument { .. } | Unsupported::Phi { .. } | Unsupported::Naked { .. } => {
466                None
467            }
468        }
469    }
470}
471
472impl fmt::Display for Unsupported {
473    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
474        match *self {
475            Unsupported::Inst { term: Some(term), .. } => write!(f, "no rule lowers `{term}`"),
476            Unsupported::Inst { term: None, opcode, ty: Some(ty), .. } => {
477                write!(f, "no rule lowers a `{opcode}` producing a `{ty}`")
478            }
479            Unsupported::Inst { term: None, opcode, ty: None, .. } => {
480                write!(f, "no rule lowers a `{opcode}`")
481            }
482            Unsupported::Argument { index, missing } => {
483                write!(f, "parameter {index} {}", missing.why())
484            }
485            Unsupported::Call { refused: Refused { argument: Some(index), missing }, .. } => {
486                write!(f, "argument {index} of this call {}", missing.why())
487            }
488            Unsupported::Call { refused: Refused { argument: None, missing }, .. } => {
489                write!(f, "what this call gives back {}", missing.why())
490            }
491            Unsupported::Returned { missing, .. } => {
492                write!(f, "what this function gives back {}", missing.why())
493            }
494            Unsupported::Dynamic { growing, .. } => {
495                write!(f, "this local {}", growing.why())
496            }
497            Unsupported::Phi { block, count, ty } => {
498                let block = block.index();
499                write!(
500                    f,
501                    "block{block} takes {count} parameters of type `{ty}` and only {X87_DEPTH} can cross an edge at once"
502                )
503            }
504            Unsupported::Assembly { refused, .. } => write!(f, "this `asm` {}", refused.why()),
505            Unsupported::Naked { bytes } => write!(
506                f,
507                "this function is `naked` and wants {bytes} bytes of frame, which there is no prologue to take"
508            ),
509        }
510    }
511}
512
513impl std::error::Error for Unsupported {}
514
515/// A lowered function, and what the frame needs that the machine IR does not hold.
516#[derive(Debug)]
517pub struct Lowered {
518    /// The function, in machine instructions.
519    pub func: mir::Func,
520    /// What it wants its stack to look like, which is separate from the function so that the two
521    /// can be read and written at the same time.
522    pub stack: Stack,
523    /// Which rules of the table lowered it, which is what `-Zrule-coverage` asks for and what
524    /// `crate::coverage` writes down.
525    pub fired: Fired,
526    /// Which machine IR block each IR block became, indexed by the IR block's own index, and
527    /// nothing for a block the walk never reached.
528    ///
529    /// Here because it is the only place the correspondence exists. Selection makes one block per
530    /// block, in the same order and with the arms in the same order, so anything the IR knows
531    /// about a block can be carried down through this and nothing else, and
532    /// [`crate::weights::carry`] is what does.
533    pub blocks: Vec<Option<mir::Block>>,
534}
535
536/// What a function's stack has to hold, as far as selection is able to say.
537///
538/// All of it is answered here because selection is where a call is built and where an `alloca`
539/// is read, and nothing after it could tell what either of them needed.
540#[derive(Debug, Default)]
541pub struct Stack {
542    /// How many bytes the widest call in the function needs below the stack pointer for the
543    /// arguments it passes there, or `None` for a function that makes no call at all.
544    ///
545    /// `None` is a leaf, which is the function that may use the red zone and the one whose stack
546    /// pointer does not have to be left aligned for anybody.
547    pub calls: Option<u32>,
548    /// The memory the function asked for itself, one entry for every `alloca` in it, in the order
549    /// the walk reached them.
550    pub locals: Vec<Local>,
551    /// Which instruction computes the address of which of those locals.
552    ///
553    /// An address in the frame is a distance from the stack pointer, and there is no frame until
554    /// after allocation, so the instruction is written here with nothing in its displacement and
555    /// [`crate::finish`] writes the number in once [`crate::frame::Frame`] knows it.
556    pub addresses: Vec<(mir::Inst, usize)>,
557    /// Which of those locals is which declaration in the source, for the ones the program declared.
558    ///
559    /// The number is the one the IR function carries and means nothing here. What it is for is the
560    /// debugging information, which has to say where a named local ended up and cannot ask the
561    /// frame directly: the frame knows a local by the order the `alloca` for it was lowered in and
562    /// by nothing else.
563    ///
564    /// Shorter than the list above rather than the same length, because most of what a function
565    /// keeps in its frame is memory an expression wanted somewhere to put.
566    pub declared: Vec<(usize, u32)>,
567    /// Which instruction computes the address of a piece of memory whose size the function works
568    /// out while it runs, which is what a variable length array is.
569    ///
570    /// Waiting on [`crate::finish`] for a different number from the one the addresses above are:
571    /// the bytes were taken off the stack pointer by the instruction in front of this one, so where
572    /// they start is however much of the bottom of the frame belongs to the arguments of a call,
573    /// and that is not known until the frame is.
574    pub dynamic: Vec<mir::Inst>,
575    /// Which instruction takes those bytes off the stack pointer, one for every one of them, in the
576    /// order the walk reached them.
577    ///
578    /// Read by [`crate::finish`] on a command line that asked for the stack to be touched a page at
579    /// a time, which is the one thing that has to find these again: the bytes are in a register by
580    /// then, so the walk down to them is a loop, and a loop is written around an instruction rather
581    /// than in front of a block. Nothing else looks at them, because everything else about a frame
582    /// that grows is answered by the address the instruction below this one computes.
583    pub grown: Vec<mir::Inst>,
584    /// Where the function first moves the stack pointer while it runs, if it does at all.
585    ///
586    /// Two things are read off this. One is whether at all, which is what [`crate::frame::Layout`]
587    /// wants, because a frame that moves its stack pointer has a different shape from one that does
588    /// not and the layout is built before the instructions are looked at again. See `Growing` in
589    /// [`crate::frame`]. The other is where, so that a caller that cannot accept such a frame has
590    /// somewhere to point when it says so.
591    pub grown_at: Option<Inst>,
592    /// Which instruction reads which of the arguments the caller passed on the stack, as how far up
593    /// the caller's argument area it reads.
594    ///
595    /// Waiting on [`crate::finish`] for the same reason the addresses above are, and on one thing
596    /// more: where the caller's argument area is from inside this function depends on whether the
597    /// prologue had to force the stack pointer's alignment, so which register the load reads
598    /// through is not settled here either.
599    pub arguments: Vec<(mir::Inst, u32)>,
600    /// Whether the function asked where its own frame is, which is what `__builtin_frame_address`
601    /// and `__builtin_return_address` both start from.
602    ///
603    /// A function like that keeps a frame pointer whatever the flags say, because the register is
604    /// the answer to the first of them and the start of the walk for every depth above zero. There
605    /// is no other way to reach it: the distance from the stack pointer to the frame is a number
606    /// the layout works out, and what a walk up the chain needs is the link the prologue saved.
607    pub walks_frames: bool,
608    /// Whether the function saved a place for a `__builtin_longjmp` to come back to, which is what
609    /// `__builtin_setjmp` does.
610    ///
611    /// A function like that keeps a frame pointer whatever the flags say as well, and for a reason
612    /// of the same shape: the two registers the restore puts back are the frame pointer and the
613    /// stack pointer, and a frame that did not keep the first of them has nothing in it saying
614    /// where the caller's frame is for the epilogue to find after control has come back.
615    pub saves_place: bool,
616}
617
618impl Stack {
619    /// The layout given, with the three fields only the lowering knows the answer to filled in.
620    ///
621    /// Everything else in a layout comes from the flags the function is compiled under or from the
622    /// allocation, so this takes one and returns it rather than building one.
623    ///
624    /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
625    /// zone, which is the words below the stack pointer nothing else may write, and a function
626    /// control comes back into from a `__builtin_longjmp` has already had something else running
627    /// down there: whatever it called and whatever that called, or a signal handler on the same
628    /// stack. Every one of those has written over the red zone by the time control arrives, so a
629    /// value this function left there would not be there any more.
630    #[must_use]
631    pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
632        Layout {
633            leaf: self.calls.is_none() && !self.saves_place,
634            outgoing: self.calls.unwrap_or(0),
635            locals: &self.locals,
636            grows: self.grown_at.is_some(),
637            ..base
638        }
639    }
640}
641
642/// The x86-64 machine IR for that function.
643///
644/// # Errors
645///
646/// The first instruction no rule fires on, which today is anything at a width the rule set is not
647/// written at, a parameter that does not arrive in a register this can read, or a call that
648/// passes something this cannot put where the convention wants it.
649pub fn func(
650    source: &Func,
651    names: &mut Interner,
652    conv: &'static CallRegs,
653    elsewhere: &Elsewhere,
654) -> Result<Lowered, Unsupported> {
655    Lowering::new(source, names, conv, elsewhere).run()
656}
657
658/// What the matcher settled on for one block, indexed the way the block's instructions are.
659struct Decided {
660    /// What each instruction matched, and nothing for one that matched no rule or was folded
661    /// into a later one.
662    found: Vec<Option<Match<Term>>>,
663    /// How each instruction showed its operands to the matcher, which is what says what it took.
664    plans: Vec<Option<Plan>>,
665    /// The instructions some other instruction took, which are the ones with nothing to write.
666    folded: Vec<Inst>,
667}
668
669/// One function being lowered.
670struct Lowering<'a> {
671    source: &'a Func,
672    names: &'a mut Interner,
673    out: mir::Func,
674    /// The machine register each IR value is in, once it has one.
675    regs: Vec<Option<mir::Reg>>,
676    /// For a constant that has been written into a register, the block it was written into,
677    /// which is the only block that register is any good in.
678    written: Vec<Option<mir::Block>>,
679    /// How many times each IR value is read, which is what says whether an instruction may be
680    /// folded into the one that reads it.
681    uses: Vec<u32>,
682    /// The block being filled.
683    at: Option<mir::Block>,
684    /// The machine IR block each IR block became.
685    blocks: Vec<Option<mir::Block>>,
686    /// The class an address is in, which is the general purpose one and is not a question: every
687    /// register an addressing mode names holds part of an address, and there is no machine here
688    /// that computes an address anywhere but in this file. Which class a *value* is in is
689    /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
690    gpr: RegClass,
691    /// Where the convention this function is compiled for puts things, which is read for the
692    /// arguments and for the calls.
693    conv: &'static CallRegs,
694    /// Which names this function may not work an address out for itself, which is a fact about the
695    /// module and so is worked out before any of this and handed in.
696    elsewhere: &'a Elsewhere,
697    /// What the function wants its stack to look like, filled in as the walk finds out.
698    stack: Stack,
699    /// What a `va_start` in this function has to write, or nothing for a function that takes no
700    /// arguments its signature does not name.
701    ///
702    /// Worked out once, when the entry block binds the parameters, because every number in it is
703    /// about where those parameters left the walk over the argument registers and there is nowhere
704    /// else that knows.
705    varargs: Option<Varargs>,
706    /// Which of the function's stack objects each eighty bit value lives in, once it has asked
707    /// for one.
708    ///
709    /// One slot per value and it is never given back, which is what makes an eighty bit value
710    /// behave like every other one: it is written once and read wherever it is read, and no two
711    /// of them share a slot the way two of them would share a register. What is in a register is
712    /// the address, and that is worked out again at every use rather than kept, so nothing here
713    /// holds a general purpose register open across a whole function.
714    slots: Vec<Option<usize>>,
715    /// The eight bytes a value passes through between a register and the x87 stack, once
716    /// something has wanted them.
717    ///
718    /// One for the whole function, because every group that uses it is a handful of instructions
719    /// with nothing in between: the bytes are written, read straight back and never looked at
720    /// again, so a second slot would be a second slot holding the same nothing.
721    crossing: Option<usize>,
722    /// The four bytes the control word is saved in and the changed copy written to, once
723    /// something has wanted them.
724    ///
725    /// One for the whole function for the reason above, and four rather than two because it is
726    /// two words: the one the unit had and the one with the rounding field turned to truncate.
727    control: Option<usize>,
728    /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
729    ///
730    /// One for the whole function however many saves there are in it, because the word is written
731    /// and read back with nothing in between: the save writes a zero into it and the instruction
732    /// straight after reads it, and the only other thing that ever writes it is a restore arriving
733    /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
734    /// inside the other.
735    answer: Option<usize>,
736    /// Which rules have fired so far.
737    fired: Fired,
738}
739
740/// What a `va_start` in a variadic function writes into the list it is given.
741///
742/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
743/// both are written down. Neither is a set of numbers on its own: where the save area is and where
744/// the caller's argument area is are distances into a frame that does not exist until after
745/// allocation, so each is a `lea` [`crate::finish`] fills in.
746#[derive(Debug, Clone, Copy, PartialEq, Eq)]
747enum Varargs {
748    /// The four field list, whose two offsets are settled here and whose two addresses are not.
749    Fields {
750        /// Which of the function's stack objects is the register save area.
751        save: usize,
752        /// How far up the caller's argument area the first argument the signature does not name is,
753        /// which is the whole of that area the named ones did not take.
754        incoming: u32,
755        /// What `gp_offset` starts at, which is past the general purpose registers the named
756        /// arguments took.
757        integers: u32,
758        /// What `fp_offset` starts at, which is past the vector ones.
759        floats: u32,
760    },
761    /// The list that is a pointer, which is the one address and nothing else.
762    Pointer {
763        /// How far up the caller's argument area the first argument the signature does not name is,
764        /// which on this convention is the word belonging to the position the named ones stopped
765        /// at.
766        incoming: u32,
767    },
768}
769
770/// How far a function's name reaches, narrowed from the linkage the IR gave it.
771///
772/// The IR has five and an object file says three, and the two the linker cannot tell apart are
773/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
774/// no way to record. A function is never `Common`, since that is what a tentative definition of an
775/// object is and there is no tentative definition of a function, and it is written here rather
776/// than left out so that a linkage added later has to come past this.
777const fn binding(linkage: Linkage) -> mir::Binding {
778    match linkage {
779        Linkage::Internal => mir::Binding::Local,
780        Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
781        Linkage::External | Linkage::Common => mir::Binding::Global,
782    }
783}
784
785/// How far a function's name reaches outside a shared library, carried across unchanged.
786///
787/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
788/// three of these and the two enumerations are the same three answers written twice: once in a
789/// crate that is not allowed to know what an object file is and once in one that is.
790const fn visibility(visibility: Visibility) -> mir::Visibility {
791    match visibility {
792        Visibility::Default => mir::Visibility::Default,
793        Visibility::Hidden => mir::Visibility::Hidden,
794        Visibility::Protected => mir::Visibility::Protected,
795    }
796}
797
798impl<'a> Lowering<'a> {
799    fn new(
800        source: &'a Func,
801        names: &'a mut Interner,
802        conv: &'static CallRegs,
803        elsewhere: &'a Elsewhere,
804    ) -> Self {
805        let counts = source.counts();
806        let name = source.name;
807        let mut uses = vec![0; counts.values];
808        for block in source.blocks() {
809            for inst in source.insts(block) {
810                for &arg in &source[source[inst].args] {
811                    uses[arg.index()] += 1;
812                }
813                for call in source.successors(inst) {
814                    for &arg in &source[call.args] {
815                        uses[arg.index()] += 1;
816                    }
817                }
818            }
819        }
820        let mut out = mir::Func::new(name);
821        out.align = source.align;
822        // Carried rather than worked out here, because where a function was declared is a fact
823        // about the source and this is a long way past it. What wants it is the line table.
824        out.declared = source.declared;
825        out.binding = binding(source.linkage);
826        out.visibility = visibility(source.visibility);
827        Self {
828            source,
829            names,
830            out,
831            regs: vec![None; counts.values],
832            written: vec![None; counts.values],
833            blocks: vec![None; counts.blocks],
834            uses,
835            at: None,
836            gpr: x86_64::GPR,
837            conv,
838            elsewhere,
839            stack: Stack::default(),
840            varargs: None,
841            slots: vec![None; counts.values],
842            crossing: None,
843            control: None,
844            answer: None,
845            fired: Fired::new(),
846        }
847    }
848
849    fn run(mut self) -> Result<Lowered, Unsupported> {
850        // Every block before any of them is filled, because a block that jumps forward has to
851        // name the block it jumps to and a machine IR block is named by a handle rather than by
852        // the IR block it came from.
853        for block in self.source.blocks() {
854            let out = self.out.create_block();
855            self.blocks[block.index()] = Some(out);
856        }
857        for block in self.order() {
858            self.block(block)?;
859        }
860        // And the name each block an image holds the address of was given, which nothing in the
861        // walk above would ask for: the `lea` a label address is inside the function needs no
862        // symbol, and the one thing that does is a relocation in another section.
863        let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
864        let labels: Vec<(mir::Block, Symbol)> =
865            named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
866        self.out.labels = labels;
867        Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
868    }
869
870    /// The order the blocks are filled in, which is not the order they are written in.
871    ///
872    /// Reverse postorder, because a value is written in a block that dominates every block that
873    /// reads it and a block in reverse postorder comes before every block it dominates. The order
874    /// the blocks are written in does not have that property: a block written early can read a
875    /// value a block below it writes, and reading a value with no register yet mints one, so the
876    /// register the definition writes later is not the register the read named. Nothing writes the
877    /// one the read named, and what comes out is a function that loads a stack slot no store ever
878    /// reached. It is the order this walk goes in rather than the order the blocks come out in,
879    /// which is what the loop above fixes, so the machine function is still written the way the IR
880    /// function was.
881    ///
882    /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
883    /// them and nothing they name is read by anything that does, but they still have to be filled,
884    /// because a machine block with no terminator is not one the passes below can read.
885    fn order(&self) -> Vec<Block> {
886        let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
887        let count = self.blocks.len();
888        let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
889        for block in self.source.blocks() {
890            let Some(term) = self.source.terminator(block) else { continue };
891            succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
892        }
893        // An explicit stack, because the depth of the walk is the number of blocks and a function
894        // built by a generator has as many of those as it likes.
895        let mut seen = vec![false; count];
896        let mut order = Vec::with_capacity(count);
897        let mut stack = vec![(entry, 0usize)];
898        seen[entry.index()] = true;
899        while let Some((block, at)) = stack.pop() {
900            let Some(&next) = succs[block.index()].get(at) else {
901                order.push(block);
902                continue;
903            };
904            stack.push((block, at + 1));
905            if !seen[next.index()] {
906                seen[next.index()] = true;
907                stack.push((next, 0));
908            }
909        }
910        order.reverse();
911        order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
912        order
913    }
914
915    /// One block: its parameters, then every instruction in it that is not folded into another.
916    fn block(&mut self, block: Block) -> Result<(), Unsupported> {
917        let out = self.out_block(block);
918        self.at = Some(out);
919        if self.source.entry() == Some(block) {
920            self.arrive(block, out)?;
921        } else {
922            let mut arriving = Vec::new();
923            for &param in &self.source[block].params {
924                // A value with no register to arrive in, which the class would not say, since
925                // `class_of` puts one of these in the general purpose file on purpose and what it
926                // means by that is that nothing there can hold it. What crosses the edge for one
927                // of those is the address of where the value already is, so the parameter is a
928                // pointer here and the bytes it points at are copied below.
929                let ty = self.source[param].ty;
930                let reg = self.out.append_param(out, self.class_of(ty));
931                self.regs[param.index()] = Some(reg);
932                if on_x87(ty) {
933                    arriving.push((param, reg));
934                }
935            }
936            self.settle(block, &arriving)?;
937        }
938
939        // What each instruction matched, and which instructions were folded into another. The
940        // decision is made for the whole block before any of it is written, and it is made more
941        // than once: a value that only some of its readers took has to be put back in a register
942        // for all of them, and taking it away from those readers changes what they match.
943        let insts: Vec<Inst> = self.source.insts(block).collect();
944        let mut refused: HashSet<Value> = HashSet::new();
945        let mut decided = self.decide(&insts, &refused);
946        while let Some(value) = self.left_alive(&insts, &decided.plans) {
947            refused.insert(value);
948            decided = self.decide(&insts, &refused);
949        }
950        let Decided { found, folded, .. } = decided;
951
952        for (&inst, matched) in insts.iter().zip(found) {
953            if folded.contains(&inst) || self.writes_nothing(inst) {
954                continue;
955            }
956            // A call is built from the convention rather than matched, which is why it is the one
957            // opcode looked at by name here. Through an address it is a different instruction and
958            // the same convention, so the two arrive at the same place and differ in one line of
959            // it.
960            match self.source[inst].opcode {
961                Opcode::Call | Opcode::CallIndirect => {
962                    self.called(inst)?;
963                    continue;
964                }
965                // Built from the frame rather than matched, for the same shape of reason a call
966                // is built from the convention: what a rule replaces a term with is instructions,
967                // and what an `alloca` needs first is bytes, which the rule language has no way
968                // to ask for.
969                Opcode::Alloca => {
970                    self.reserve(inst)?;
971                    continue;
972                }
973                // Reading the stack pointer and writing it back, which are the two ends of a scope
974                // holding a variable length array. Built here for the reason an `alloca` is: the
975                // value is a register the rule language has no way to name, because what it holds
976                // is not a value the program computed but where the machine's stack had got to.
977                Opcode::StackSave => {
978                    self.stack_pointer(inst, false)?;
979                    continue;
980                }
981                Opcode::StackRestore => {
982                    self.stack_pointer(inst, true)?;
983                    continue;
984                }
985                // The address of a name, built here for the same reason an `alloca` is: what a
986                // rule replaces a term with is instructions over values, and the operand of this
987                // one is a symbol, which is a thing the rule language has no way to bind and the
988                // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
989                // proof over bitvectors could discharge, because what makes it the right answer
990                // is the relocation and what the linker does with it.
991                Opcode::GlobalAddr => {
992                    self.address_of(inst)?;
993                    continue;
994                }
995                // The address of a label and the branch that reads one, built here for the same
996                // reason and for one more. The reason is the same: what the first of them names is
997                // a block, which is not a value a rule pattern can bind, and there is nothing in
998                // the distance between two places in one function that a proof over bitvectors
999                // could discharge. The extra one is that the second is a terminator whose arms are
1000                // not two and not fixed, and a rule says what an instruction reads rather than
1001                // where a block goes.
1002                Opcode::BlockAddr => {
1003                    self.block_address(inst)?;
1004                    continue;
1005                }
1006                Opcode::IndirectBr => {
1007                    self.indirect_branch(inst)?;
1008                    continue;
1009                }
1010                // The pair that saves a place in this function and comes back to it. Built here
1011                // for the reason the address of a label is, and for two more. The reason is the
1012                // same: the first of them writes down where control comes back to, which is a
1013                // place in this function and not a value a rule pattern can bind. The extra ones
1014                // are that each of them is a group of instructions over a buffer the program owns
1015                // rather than one instruction, and that the first of them leaves the block it was
1016                // written in and carries on in a new one, which is a thing no rule can do.
1017                Opcode::SetjmpMarker => {
1018                    self.saves_place(inst)?;
1019                    continue;
1020                }
1021                Opcode::LongjmpMarker => {
1022                    self.comes_back(inst)?;
1023                    continue;
1024                }
1025                // Where this thread's own storage starts, built here for a reason of the same
1026                // shape: what it reads is `%fs`, which is not a register the rule language can
1027                // bind and not one a proof over bitvectors could say anything about, because what
1028                // makes the load the right answer is an agreement between the loader and the C
1029                // library rather than any arithmetic.
1030                Opcode::ThreadPointer => {
1031                    self.thread_pointer(inst)?;
1032                    continue;
1033                }
1034                // Where a frame is and what it returns to, built here for the same reason and one
1035                // more. The reason is the same: what the walk starts from is the frame pointer,
1036                // which is not a register a rule pattern can bind, and there is nothing in reading
1037                // the link the prologue saved that a proof over bitvectors could discharge. The
1038                // extra one is that how long the walk is comes out of a number beside the
1039                // instruction, so one of these is not one instruction but however many the depth
1040                // says, and a rule replaces a term with a term.
1041                Opcode::FrameAddress | Opcode::ReturnAddress => {
1042                    self.frames(inst)?;
1043                    continue;
1044                }
1045                // Built from the frame for the reason an `alloca` is, and from the convention for
1046                // the reason a call is: three of the four fields it writes are distances that do
1047                // not exist until the frame does, and the fourth is where the walk over the
1048                // argument registers stopped. A function that is not variadic has no such walk to
1049                // report, so it has nothing here and is refused below, which is the right answer
1050                // for a `va_start` in one.
1051                Opcode::VaStart if self.varargs.is_some() => {
1052                    self.va_start(inst)?;
1053                    continue;
1054                }
1055                // A return of more than one value, which is a structure small enough to come
1056                // back in a pair of registers. Built from the convention for the reason a call
1057                // is: which register each half goes in depends on the halves in front of it,
1058                // because the two register files are walked separately, and a pattern over a term
1059                // cannot see them. A return of one value is a term with a name and a rule, and it
1060                // stays one.
1061                //
1062                // A return of none in a function whose answer went through memory is here too,
1063                // and for a different reason: what it gives back is not written in the IR at all.
1064                // The convention says the address the caller handed over comes back, and only the
1065                // signature says this function was handed one.
1066                //
1067                // And a return of one eighty bit value, for a third reason: what a rule would
1068                // write is an instruction leaving the value in a register, and this one is left on
1069                // the x87 stack instead. A rule could not name that stack any more than any other
1070                // rule about this type could.
1071                Opcode::Return
1072                    if self.source[self.source[inst].args].len() > 1
1073                        || self.sret().is_some()
1074                        || self.gives_back_x87(inst) =>
1075                {
1076                    self.returned(inst)?;
1077                    continue;
1078                }
1079                // A cast between a pointer and an integer of the same width, which on this
1080                // machine is every one the front end writes. No instruction at all, so no rule
1081                // could name one.
1082                Opcode::PtrToInt | Opcode::IntToPtr => {
1083                    self.rename(inst)?;
1084                    continue;
1085                }
1086                // A barrier, which is one instruction or none depending on the ordering. Written
1087                // by name because there is nothing about it a rule could be proved against, the
1088                // way there is nothing to prove about the address of a symbol.
1089                Opcode::Fence => {
1090                    self.barrier(inst)?;
1091                    continue;
1092                }
1093                // A hint, written by name for the reason a barrier is and one step further: not
1094                // only is there no equality for a proof to discharge, there is nothing about the
1095                // program around it either. Which of the four instructions it is comes out of the
1096                // number the builtin was given, which is beside the instruction rather than in it.
1097                Opcode::Prefetch => {
1098                    self.hint(inst)?;
1099                    continue;
1100                }
1101                // Stopping, written by name for the first half of the barrier's reason: it
1102                // computes nothing, so there is no term for a rule to replace, and what makes it
1103                // right is what the operating system does with the fault rather than anything a
1104                // proof over bitvectors could discharge.
1105                Opcode::Trap => {
1106                    self.trap(inst);
1107                    continue;
1108                }
1109                // A compare and exchange, which is written by name because it produces two values
1110                // and a rule produces one. The replacement of a rule is one term, a term names the
1111                // value an instruction computes, and there is no way in that language to say that
1112                // an instruction leaves an answer in one place and a yes or no in another.
1113                Opcode::Cmpxchg => {
1114                    self.exchange(inst)?;
1115                    continue;
1116                }
1117                // A read modify write, which is written by name for a different reason: it produces
1118                // one value, so a rule could name it, and what it does is not in the head a rule
1119                // matches on. Every one of the thirteen operations is the same opcode at the same
1120                // type and differs only in what is carried beside it, so one pattern would be all
1121                // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1122                // since `crate::retry` turned the rest into loops a long way above this.
1123                Opcode::AtomicRmw => {
1124                    self.modify(inst)?;
1125                    continue;
1126                }
1127                // An `asm` statement, whose lowering is its template and there is no term for a
1128                // string. Written by name for the reason a barrier is, and before the x87 arm
1129                // below so that an `asm` holding a `long double` is refused as the `asm` it is
1130                // rather than as an instruction nothing computes.
1131                Opcode::InlineAsm => {
1132                    self.assembly(inst)?;
1133                    continue;
1134                }
1135                // Anything at all with an eighty bit float in it, which is the one arm here
1136                // chosen by a type rather than by an opcode, because what makes these different
1137                // is not what they do but where the value is. A `long double` has no register,
1138                // so it has no name in `crate::term` and no rule could bind one: every one of
1139                // these is a group of instructions over a frame slot, written out below.
1140                //
1141                // Last of the arms, so that a call and a return with one of these in them reach
1142                // the convention first and are refused by it, which is the truer answer: what is
1143                // wrong there is where the value has to travel and not that nothing can compute
1144                // it.
1145                _ if self.touches_x87(inst) => {
1146                    self.x87(inst)?;
1147                    continue;
1148                }
1149                _ => {}
1150            }
1151            let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1152            self.emit(inst, &matched)?;
1153            // After it is built rather than when it matched, so that what is recorded is the rules
1154            // this function was lowered by and not the rules something was tried with.
1155            self.fired.mark(matched.rule);
1156        }
1157        // Whichever block the walk ended in rather than the one it started in. The two are the
1158        // same block for every function that does not save a place for a `__builtin_longjmp`, and
1159        // where they differ it is the last of them that the terminator and the arms belong to.
1160        // See [`Self::saves_place`].
1161        let last = self.at.expect("a block is being filled");
1162        self.edges(block, last)
1163    }
1164
1165    /// One call, which is built from the convention rather than matched against the table for the
1166    /// same reason the arguments of the function itself are.
1167    ///
1168    /// The arguments are read before the call is built, which is what materializes a constant
1169    /// argument into a register, since no call passes an immediate.
1170    ///
1171    /// A call to a name and a call through an address are both here, and what tells them apart is
1172    /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1173    /// reads. Through an address the first operand is the address and the arguments are the ones
1174    /// behind it, and everything after that is the same: where each argument goes, where the value
1175    /// comes back and which registers are gone across it are the convention's answers and the
1176    /// convention does not ask what is being called.
1177    fn called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1178        let data = &self.source[inst];
1179        let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1180        let info = self.source[info];
1181        let indirect = data.opcode == Opcode::CallIndirect;
1182
1183        let values: Vec<Value> = self.source[data.args].to_vec();
1184        let callee = if indirect {
1185            let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1186            abi::Callee::Through(self.reg_of(address)?)
1187        } else {
1188            abi::Callee::Named(info.callee.ok_or_else(|| self.unsupported(inst))?)
1189        };
1190
1191        // What the ABI asks of each argument, read out before any of them is, because reading one
1192        // borrows the function this is a table in. The ones the signature names are the signature's
1193        // answer and the ones behind them are the call's, which is where a structure passed to a
1194        // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1195        let signature = &self.source[info.signature];
1196        let variadic = signature.variadic;
1197        let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1198        let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1199        // Every value that comes back and not only the first. A structure small enough to travel
1200        // in registers comes back in up to two of them, and which register each half is in is the
1201        // convention's answer, which is why the whole list goes to the same place the arguments do
1202        // rather than to a rule.
1203        let returns: Vec<Type> = signature.return_types().collect();
1204
1205        let mut args = Vec::with_capacity(values.len());
1206        for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1207            let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1208            let abi = abi.copied().unwrap_or_default();
1209            let ty = self.source[value].ty;
1210            // What travels for an eighty bit value is its bytes, so what the call is handed is
1211            // where they are rather than a register they are in, and there is no register they
1212            // could be in. Everything else about it is a sixteen byte object passed by value and
1213            // is built by the same code.
1214            let reg =
1215                if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1216            args.push(abi::Passing { ty, reg, abi });
1217        }
1218        let block = self.at.expect("a block is being filled");
1219        let what = abi::Calling {
1220            callee,
1221            args: &args,
1222            returns: &returns,
1223            variadic,
1224            named: named.len(),
1225            at: self.source.span(inst),
1226        };
1227        let made = abi::call(&mut self.out, block, &what, self.conv, self.names)
1228            .map_err(|refused| Unsupported::Call { inst, refused })?;
1229        let calls = &mut self.stack.calls;
1230        *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1231        // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1232        // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1233        // front of everything the block does next, and after it the value is in its slot and is
1234        // read the way every other one is.
1235        let results: Vec<Value> = self.source[inst].results().collect();
1236        if let [result] = results[..] {
1237            if abi::on_the_stack(self.source[result].ty) {
1238                let span = self.source.span(inst);
1239                let into = self.x87_slot(result);
1240                let into = self.through(into);
1241                self.x87_at("fstp_t", span, into);
1242                return Ok(());
1243            }
1244        }
1245        for (result, &reg) in results.into_iter().zip(&made.results) {
1246            self.regs[result.index()] = Some(reg);
1247        }
1248        Ok(())
1249    }
1250
1251    /// The pointer a function returning through memory was handed, or nothing in a function that
1252    /// was not.
1253    ///
1254    /// It is the first parameter and the signature is what says so, since in the IR it is an
1255    /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1256    /// like that and no entry block has nothing to give back and no body to give it back from.
1257    fn sret(&self) -> Option<Value> {
1258        let first = self.source.signature().params.first()?;
1259        if !matches!(first.abi, Abi::Sret { .. }) {
1260            return None;
1261        }
1262        self.source[self.source.entry()?].params.first().copied()
1263    }
1264
1265    /// One `return` the convention has to write, as the place each value has to be in by the end.
1266    ///
1267    /// One pseudo per value, each a read constrained to a return register, which is what a return
1268    /// of one value already is and is the whole of what either does. The `ret` itself comes from
1269    /// the epilogue for both, long after this, because the frame has to be given back first.
1270    ///
1271    /// The two register files are counted separately, so a structure of a `double` and a `long`
1272    /// leaves the `double` in the first vector register and the `long` in the first integer one
1273    /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1274    /// the other side of the call, which is what makes the two ends agree.
1275    ///
1276    /// A function whose answer went through memory gives back the address it was handed, in front
1277    /// of nothing else, because a signature that returns that way returns nothing else. That the
1278    /// caller already knows the address is not enough: it is allowed to read the register instead,
1279    /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1280    /// is usually the right answer by accident, and one call in the body is enough to make it a
1281    /// wild pointer, which is why this is written rather than left to luck.
1282    ///
1283    /// Where everything goes is worked out before anything is written, so a return this cannot
1284    /// make leaves no half of one behind.
1285    /// Whether what a `return` gives back is the one value that goes back on the x87 stack.
1286    fn gives_back_x87(&self, inst: Inst) -> bool {
1287        let [value] = self.source[self.source[inst].args] else { return false };
1288        abi::on_the_stack(self.source[value].ty)
1289    }
1290
1291    fn returned(&mut self, inst: Inst) -> Result<(), Unsupported> {
1292        let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
1293        let (mut ints, mut floats) = (0usize, 0usize);
1294        let mut parts = Vec::with_capacity(values.len() + 1);
1295        // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1296        // and is the one place a value is left rather than put in a register. So the whole of the
1297        // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1298        // `ret`, which is the one time in this file that is true and is what the convention asks
1299        // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1300        // the unit.
1301        if let [value] = values[..] {
1302            let ty = self.source[value].ty;
1303            if abi::on_the_stack(ty) && self.sret().is_none() {
1304                let span = self.source.span(inst);
1305                let from = self.x87_slot(value);
1306                let from = self.through(from);
1307                self.x87_at("fld_t", span, from);
1308                return Ok(());
1309            }
1310        }
1311        for value in self.sret().into_iter().chain(values) {
1312            let ty = self.source[value].ty;
1313            let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1314            // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1315            // says so itself, and a type that travels perfectly well ran out of registers.
1316            let missing = abi::refuses(ty).unwrap_or(Missing::NoRoom);
1317            let name = abi::ret_of(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1318            *at += 1;
1319            // The register is the target's answer and not one worked out here, the same as it is
1320            // for a return of one value, so that both halves of a pair and every rule that writes
1321            // half of one are reading the same table.
1322            let opcode = name.strip_prefix(PREFIX).expect("a machine instruction of this target");
1323            let form = x86_64::form(opcode).ok_or_else(|| self.unsupported(inst))?;
1324            let [desc] = form.operands() else { return Err(self.unsupported(inst)) };
1325            parts.push((self.names.intern(name), self.reg_of(value)?, *desc));
1326        }
1327
1328        let block = self.at.expect("a block is being filled");
1329        let span = self.source.span(inst);
1330        for (opcode, reg, desc) in parts {
1331            let operand = mir::Operand {
1332                reg,
1333                class: desc.class,
1334                role: desc.role,
1335                constraint: desc.constraint,
1336            };
1337            self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1338        }
1339        Ok(())
1340    }
1341
1342    /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1343    /// address of them is one instruction.
1344    ///
1345    /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1346    /// the frame in every function, and its displacement is left at nothing because there is no
1347    /// frame yet. Which instruction is waiting for which local is remembered, and
1348    /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1349    ///
1350    /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1351    /// that is what stops it being folded into something else. An operand shown as the
1352    /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1353    /// name is one no pattern can reach past, and the address it computes is always in a register
1354    /// by the time anything reads it.
1355    fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1356        let data = &self.source[inst];
1357        // A variable length array carries the size it wants as an operand rather than in the
1358        // instruction, which is the whole of what tells the two apart here.
1359        if let Some(&size) = self.source[data.args].first() {
1360            return self.grow(inst, size);
1361        }
1362        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1363        let info = self.source[mem];
1364        let size = u32::try_from(info.size)
1365            .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1366        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1367
1368        // At least one, because the frame divides by the alignment and an object with no
1369        // alignment at all is one the front end had nothing to say about rather than one that may
1370        // go anywhere.
1371        let index = self.stack.locals.len();
1372        self.stack.locals.push(Local { size, align: info.align.max(1) });
1373        if let Some(decl) = self.source.mem_decl(mem) {
1374            self.stack.declared.push((index, decl));
1375        }
1376
1377        let block = self.at.expect("a block is being filled");
1378        let reg = self.new_reg(result);
1379        let span = self.source.span(inst);
1380        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
1381        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1382        let made =
1383            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1384        self.stack.addresses.push((made, index));
1385        Ok(())
1386    }
1387
1388    /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1389    /// is what a variable length array is.
1390    ///
1391    /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1392    /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1393    /// where the declaration stands, which is two instructions:
1394    ///
1395    /// ```text
1396    ///   sub sp, bytes     the stack pointer moves down over the memory, which is what takes it
1397    ///   lea reg, [sp+n]   where the memory starts, which is above the outgoing argument area
1398    /// ```
1399    ///
1400    /// The displacement is left at nothing for the reason the constant kind leaves its own at
1401    /// nothing, and for a different number: that area belongs to the arguments of whatever this
1402    /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1403    /// how big it is is not known until every call in the function has been seen.
1404    ///
1405    /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1406    /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1407    /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1408    ///
1409    /// Two instructions here and not always two in the finished function. On a command line that
1410    /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1411    /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1412    /// instruction is written down in [`Stack::grown`] as well as left where it is.
1413    ///
1414    /// An array wanting more alignment than the convention leaves the stack pointer with does not
1415    /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1416    /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1417    /// is a block asking for the convention's alignment like any other. The refusal below is what
1418    /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1419    /// would be a second rounding of a register the frame already rounded, and after it no
1420    /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1421    fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1422        let data = &self.source[inst];
1423        let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1424        let info = self.source[mem];
1425        if info.align > self.conv.stack_align {
1426            return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1427        }
1428        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1429        let bytes = self.reg_of(size)?;
1430
1431        let block = self.at.expect("a block is being filled");
1432        let span = self.source.span(inst);
1433        let stack = mir::Reg::physical(self.conv.stack_pointer);
1434        let grow = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.grow)));
1435        let took = self
1436            .out
1437            .build(block, grow)
1438            .at(span)
1439            .operand(mir::Operand::write(stack, self.gpr))
1440            .operand(mir::Operand::read(stack, self.gpr))
1441            .operand(mir::Operand::read(bytes, self.gpr))
1442            .finish();
1443        self.stack.grown.push(took);
1444
1445        let reg = self.new_reg(result);
1446        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
1447        let sp = mir::Operand::read(stack, self.gpr);
1448        let made =
1449            self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1450        self.stack.dynamic.push(made);
1451        self.stack.grown_at.get_or_insert(inst);
1452        Ok(())
1453    }
1454
1455    /// Where the stack pointer is, kept so that something later can put it back.
1456    ///
1457    /// One move out of the stack pointer and one move into it, which is the whole of what the two
1458    /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1459    /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1460    /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1461    /// jump out of the scope gives the bytes back on the way out.
1462    ///
1463    /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1464    /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
1465    /// which is exactly the register that still means something after the stack pointer has moved.
1466    fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
1467        let data = &self.source[inst];
1468        let block = self.at.expect("a block is being filled");
1469        let span = self.source.span(inst);
1470        let stack = mir::Reg::physical(self.conv.stack_pointer);
1471        let mov = x86_64::FRAME.moves(self.gpr).expect("a class the target says how to move").mov;
1472        let mov = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{mov}")));
1473        let (write, read) = if into {
1474            let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
1475            (stack, self.reg_of(saved)?)
1476        } else {
1477            let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1478            (self.new_reg(result), stack)
1479        };
1480        self.out
1481            .build(block, mov)
1482            .at(span)
1483            .operand(mir::Operand::write(write, self.gpr))
1484            .operand(mir::Operand::read(read, self.gpr))
1485            .finish();
1486        // Only the write is a move of the stack pointer, and it is the one that makes the frame a
1487        // growing one. A read of it in a function that never writes it back is a function that
1488        // asked where the stack was and did nothing with the answer.
1489        if into {
1490            self.stack.grown_at.get_or_insert(inst);
1491        }
1492        Ok(())
1493    }
1494
1495    /// Whether an instruction has an eighty bit float anywhere in it.
1496    ///
1497    /// Producing one and reading one are the same question here, because what makes one of these
1498    /// different from every other instruction is not the operation but where the value is. A
1499    /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
1500    /// of the time, and neither of those is somewhere the operand of a rule could point.
1501    fn touches_x87(&self, inst: Inst) -> bool {
1502        let data = &self.source[inst];
1503        data.results().any(|value| on_x87(self.source[value].ty))
1504            || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
1505    }
1506
1507    /// Everything that happens to an eighty bit float, as the group of instructions it is.
1508    ///
1509    /// The first six move one, and every one of those is a load, a store, or a load and a store at
1510    /// two different formats, because that is the whole of what this machine converts with: the
1511    /// x87 has no instruction that turns one thing on its stack into another, so a widening is
1512    /// `fld` of the narrow format and a narrowing is `fstp` of it.
1513    ///
1514    /// The rest work on one, and they are here rather than in a rule for the same reason the six
1515    /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
1516    /// top of a stack nothing allocates from, so there is no value in the middle of the group for
1517    /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
1518    /// two instructions folded into one opcode, which is where the byte it produces comes from.
1519    ///
1520    /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
1521    /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
1522    /// below is answered by a pop a line or two later, so no two groups can ever be looking at
1523    /// the same eight registers.
1524    fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
1525        match self.source[inst].opcode {
1526            Opcode::Load => self.x87_load(inst),
1527            Opcode::Store => self.x87_store(inst),
1528            Opcode::FPExt => self.x87_widen(inst),
1529            Opcode::FPTrunc => self.x87_narrow(inst),
1530            Opcode::SIToFP => self.x87_from_signed(inst),
1531            Opcode::FPToSI => self.x87_to_signed(inst),
1532            Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
1533            Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
1534            Opcode::FMul => self.x87_arith(inst, "fmul_p"),
1535            Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
1536            Opcode::FNeg => self.x87_flip(inst),
1537            Opcode::FCmp => self.x87_compare(inst),
1538            Opcode::FConst => self.x87_const(inst),
1539            _ => Err(self.unsupported(inst)),
1540        }
1541    }
1542
1543    /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
1544    /// into slots of the block's own.
1545    ///
1546    /// What crosses an edge for a value of this type is an address, because the value is sixteen
1547    /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
1548    /// second edge into the same block hands over a second one, and a read after the block would
1549    /// then be a read of whichever edge was taken rather than of one place. So the block has a
1550    /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
1551    /// every other type gets from the allocator.
1552    ///
1553    /// Every load runs before every store and the stores run backwards, so all of the values are
1554    /// on the x87 stack at once and nothing reads a slot another one has already written. That
1555    /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
1556    /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
1557    /// deep, and a block with more of these than that is refused rather than copied in an order
1558    /// that could be wrong.
1559    fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
1560        let Some(&(first, _)) = arriving.first() else { return Ok(()) };
1561        if arriving.len() > X87_DEPTH {
1562            let ty = self.source[first].ty;
1563            return Err(Unsupported::Phi { block, count: arriving.len(), ty });
1564        }
1565        // A block parameter comes from no instruction, so what this points at is the first thing
1566        // in the block, which is where a reader looking for the copy would look.
1567        let first_inst = self.source.insts(block).next();
1568        let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
1569        for &(_, reg) in arriving {
1570            let from = self.through(reg);
1571            self.x87_at("fld_t", span, from);
1572        }
1573        for &(param, _) in arriving.iter().rev() {
1574            let into = self.x87_slot(param);
1575            let into = self.through(into);
1576            self.x87_at("fstp_t", span, into);
1577        }
1578        Ok(())
1579    }
1580
1581    /// The frame slot an eighty bit value lives in, as its address in a fresh register.
1582    ///
1583    /// The slot is the value's for the whole function and is taken the first time somebody asks.
1584    /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
1585    /// address kept in a register from the definition to the last use would hold a general purpose
1586    /// register open across everything in between, and a function with a handful of these in it
1587    /// would spend its registers on addresses of things rather than on things.
1588    fn x87_slot(&mut self, value: Value) -> mir::Reg {
1589        // An argument of the function has a slot already and it is the caller's. The convention
1590        // puts the bytes in the argument area and hands over where they are, so the address that
1591        // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
1592        // value of this type once it exists, so nothing writes to the caller's copy either. A
1593        // parameter of any other block is not this: what arrived there is an address a predecessor
1594        // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
1595        // bytes landed in is the one below.
1596        let entry = self.source.entry();
1597        if let (Def::Param { block, .. }, Some(reg)) =
1598            (self.source[value].def, self.regs[value.index()])
1599        {
1600            if entry == Some(block) {
1601                return reg;
1602            }
1603        }
1604        let index = match self.slots[value.index()] {
1605            Some(index) => index,
1606            None => {
1607                let index = self.stack.locals.len();
1608                self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
1609                self.slots[value.index()] = Some(index);
1610                index
1611            }
1612        };
1613        let block = self.at.expect("a block is being filled");
1614        self.frame_address(block, index)
1615    }
1616
1617    /// The bytes a value crosses between a register and the x87 stack through, as their address
1618    /// in a fresh register.
1619    fn x87_crossing(&mut self) -> mir::Reg {
1620        let index = match self.crossing {
1621            Some(index) => index,
1622            None => {
1623                let index = self.stack.locals.len();
1624                self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
1625                self.crossing = Some(index);
1626                index
1627            }
1628        };
1629        let block = self.at.expect("a block is being filled");
1630        self.frame_address(block, index)
1631    }
1632
1633    /// The two control words, as the address of the first of them in a fresh register.
1634    fn x87_control(&mut self) -> mir::Reg {
1635        let index = match self.control {
1636            Some(index) => index,
1637            None => {
1638                let index = self.stack.locals.len();
1639                self.stack.locals.push(Local { size: 4, align: 4 });
1640                self.control = Some(index);
1641                index
1642            }
1643        };
1644        let block = self.at.expect("a block is being filled");
1645        self.frame_address(block, index)
1646    }
1647
1648    /// An address held in a register, as the addressing mode that reaches it.
1649    fn through(&self, reg: mir::Reg) -> mir::Mem {
1650        mir::Mem::at(mir::Operand::read(reg, self.gpr))
1651    }
1652
1653    /// One instruction of a group, which names an address and nothing else.
1654    ///
1655    /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
1656    /// the mnemonic rather than in an operand, so there is no register to write down and no
1657    /// register the allocator gets a say in.
1658    fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
1659        let block = self.at.expect("a block is being filled");
1660        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1661        self.out.build(block, opcode).at(span).mem(at).finish();
1662    }
1663
1664    /// The one instruction of a group that reaches the program's own memory.
1665    ///
1666    /// A `long double` moves in two instructions with a frame slot at one end of them, and the
1667    /// other end is the address the program wrote. That end is the access, so it is the one that
1668    /// carries what the program said about it, and the trip through the slot is this compiler's
1669    /// own business the way a spill is. See [`Self::carried`].
1670    fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
1671        let block = self.at.expect("a block is being filled");
1672        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1673        let (span, flags) = (self.source.span(inst), self.carried(inst));
1674        self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
1675    }
1676
1677    /// One instruction of a group that names nothing at all.
1678    ///
1679    /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
1680    /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
1681    /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
1682    /// from. What it works on is which two pushes came before it, which is a fact about the order
1683    /// of the group and is why the group is written in one place.
1684    fn x87_only(&mut self, name: &str, span: Span) {
1685        let block = self.at.expect("a block is being filled");
1686        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
1687        self.out.build(block, opcode).at(span).finish();
1688    }
1689
1690    /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
1691    ///
1692    /// Two instructions rather than the two general purpose moves the same sixteen bytes would
1693    /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
1694    /// in the format it was already in and comes back off in it, so a signalling NaN stays one
1695    /// and nothing is raised. Which is what makes this a copy at all.
1696    fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
1697        let (args, result) = self.ends(inst)?;
1698        let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
1699        let span = self.source.span(inst);
1700        let from = self.reg_of(address)?;
1701        let from = self.through(from);
1702        let into = self.x87_slot(result);
1703        let into = self.through(into);
1704        self.x87_touching("fld_t", inst, from);
1705        self.x87_at("fstp_t", span, into);
1706        Ok(())
1707    }
1708
1709    /// A `store` of a `long double`: the same pair the other way round.
1710    fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
1711        let args = self.source[self.source[inst].args].to_vec();
1712        let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
1713        let span = self.source.span(inst);
1714        let from = self.x87_slot(value);
1715        let from = self.through(from);
1716        let into = self.reg_of(address)?;
1717        let into = self.through(into);
1718        self.x87_at("fld_t", span, from);
1719        self.x87_touching("fstp_t", inst, into);
1720        Ok(())
1721    }
1722
1723    /// A `float`, a `double` or an integer becoming a `long double`.
1724    ///
1725    /// Through memory, because the x87 reads memory and nothing else: the value is in a register
1726    /// the machine has and the unit has no way to be handed one, so it is written to the crossing
1727    /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
1728    /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
1729    /// sixty four bit integer outright, so none of the four can round and none can raise.
1730    fn x87_across(
1731        &mut self,
1732        inst: Inst,
1733        put: &'static str,
1734        class: RegClass,
1735        get: &'static str,
1736    ) -> Result<(), Unsupported> {
1737        let (args, result) = self.ends(inst)?;
1738        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1739        let span = self.source.span(inst);
1740        let value = self.reg_of(source)?;
1741        let across = self.x87_crossing();
1742        let across = self.through(across);
1743        let into = self.x87_slot(result);
1744        let into = self.through(into);
1745
1746        let block = self.at.expect("a block is being filled");
1747        let store = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{put}")));
1748        self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
1749        self.x87_at(get, span, across);
1750        self.x87_at("fstp_t", span, into);
1751        Ok(())
1752    }
1753
1754    /// A `long double` becoming a `float`, a `double` or an integer.
1755    ///
1756    /// Through memory for the reason above and in the same three instructions backwards. The two
1757    /// that go to a float round to nearest, which is what the control word says unless somebody
1758    /// has changed it and is what C wants. The two that go to an integer do not, which is why they
1759    /// do not come here.
1760    fn x87_back(
1761        &mut self,
1762        inst: Inst,
1763        put: &'static str,
1764        get: &'static str,
1765        class: RegClass,
1766    ) -> Result<(), Unsupported> {
1767        let (args, result) = self.ends(inst)?;
1768        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1769        let span = self.source.span(inst);
1770        let from = self.x87_slot(source);
1771        let from = self.through(from);
1772        let across = self.x87_crossing();
1773        let across = self.through(across);
1774
1775        self.x87_at("fld_t", span, from);
1776        self.x87_at(put, span, across);
1777        let block = self.at.expect("a block is being filled");
1778        let reg = self.new_reg(result);
1779        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{get}")));
1780        self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
1781        Ok(())
1782    }
1783
1784    /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
1785    fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
1786        let sse = self.conv.sse_class;
1787        match self.source[self.narrow(inst)?].ty.bits() {
1788            32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
1789            64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
1790            _ => Err(self.unsupported(inst)),
1791        }
1792    }
1793
1794    /// An `fptrunc` down from a `long double`, which is the other direction of the same.
1795    fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
1796        let sse = self.conv.sse_class;
1797        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
1798        match self.source[result].ty.bits() {
1799            32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
1800            64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
1801            _ => Err(self.unsupported(inst)),
1802        }
1803    }
1804
1805    /// A `sitofp` up to a `long double`.
1806    ///
1807    /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
1808    /// before it converts one and the front end writes that widening down. An unsigned integer is
1809    /// not here at all: `fild` reads its operand as signed, so a value above the signed range
1810    /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
1811    /// rather than a move and waits with the rest of it.
1812    fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
1813        let gpr = self.gpr;
1814        match self.source[self.narrow(inst)?].ty.bits() {
1815            32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
1816            64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
1817            _ => Err(self.unsupported(inst)),
1818        }
1819    }
1820
1821    /// An `fptosi` down from a `long double`, which is the one conversion here with no single
1822    /// instruction behind it.
1823    ///
1824    /// C cuts towards zero and the unit rounds the way its control word says, so the store that
1825    /// takes the value off the stack is wrapped in the control word being saved, changed and put
1826    /// back. Five instructions around the one that does the work, and three more moving the word
1827    /// through a register, because this machine has no way to OR a constant into memory at this
1828    /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
1829    /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
1830    /// that can gate an instruction on a feature yet.
1831    fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
1832        let (args, result) = self.ends(inst)?;
1833        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1834        let (put, get) = match self.source[result].ty.bits() {
1835            32 => ("fistp_l", "mov_rm_32"),
1836            64 => ("fistp_ll", "mov_rm_64"),
1837            _ => return Err(self.unsupported(inst)),
1838        };
1839        let span = self.source.span(inst);
1840        let gpr = self.gpr;
1841        let from = self.x87_slot(source);
1842        let from = self.through(from);
1843        let across = self.x87_crossing();
1844        let across = self.through(across);
1845        let control = self.x87_control();
1846        let saved = self.through(control).plus(0);
1847        let cut = self.through(control).plus(2);
1848
1849        // The word the unit has now, into the first of the two slots and into a register, with the
1850        // rounding field turned to truncate on the way to the second.
1851        self.x87_at("fnstcw", span, saved);
1852        let block = self.at.expect("a block is being filled");
1853        let was = self.out.new_vreg(gpr);
1854        let read = mir::Opcode::new(self.names.intern("x64.mov_rm_16"));
1855        self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
1856        let now = self.out.new_vreg(gpr);
1857        let set = mir::Opcode::new(self.names.intern("x64.or_ri_16"));
1858        // Two address, which is written out here rather than taken from the two shorthands
1859        // because the shorthands leave an operand unconstrained: this machine ORs into the
1860        // register it read, so the two have to be the same one and only the constraint says so.
1861        self.out
1862            .build(block, set)
1863            .at(span)
1864            .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
1865            .operand(mir::Operand::read(was, gpr))
1866            .imm(X87_TRUNCATE)
1867            .finish();
1868        let write = mir::Opcode::new(self.names.intern("x64.mov_mr_16"));
1869        self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
1870
1871        // The conversion itself, under the changed word, and then the word the unit had put back
1872        // before anything else runs.
1873        self.x87_at("fldcw", span, cut);
1874        self.x87_at("fld_t", span, from);
1875        self.x87_at(put, span, across);
1876        self.x87_at("fldcw", span, saved);
1877
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, gpr).mem(across).finish();
1882        Ok(())
1883    }
1884
1885    /// A constant of this type, as the bits of it written into its slot.
1886    ///
1887    /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
1888    /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
1889    /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
1890    ///
1891    /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
1892    /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
1893    /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
1894    /// wide and they are unspecified in the psABI rather than zero.
1895    ///
1896    /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
1897    /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
1898    /// four instructions in the frame is what that costs until it does.
1899    fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
1900        let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
1901        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
1902        let bits = self.source[imm].bits();
1903        let span = self.source.span(inst);
1904        let gpr = self.gpr;
1905        let slot = self.x87_slot(result);
1906        let low = self.through(slot).plus(0);
1907        let high = self.through(slot).plus(8);
1908
1909        let block = self.at.expect("a block is being filled");
1910        for (bytes, at, into) in
1911            [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
1912        {
1913            let held = self.out.new_vreg(gpr);
1914            let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_{into}")));
1915            self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
1916            let store = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_mr_{into}")));
1917            self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
1918        }
1919        Ok(())
1920    }
1921
1922    /// One arithmetic instruction on two eighty bit values, as the four it takes.
1923    ///
1924    /// The left operand is pushed first and the right one on top of it, so the left ends up
1925    /// underneath and the answer wanted is the one below against the top in that order. Which of
1926    /// the two mnemonics computes that is a question about the spelling rather than about the
1927    /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
1928    /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
1929    /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
1930    /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
1931    ///
1932    /// An addition and a multiplication have one form each and do not care, which is why a test
1933    /// that reads the mnemonic back would not have caught this and one that computes a subtraction
1934    /// and checks the answer does.
1935    ///
1936    /// The answer is left where the deeper of the two was and the shallower is gone, which is what
1937    /// the `p` on the mnemonic means, so one push has already been paid back by the time the
1938    /// `fstp` runs and the stack is level again after it.
1939    ///
1940    /// Nothing here is folded and nothing is reused. Two values that are the same value get two
1941    /// pushes of the same slot, and an operand that was just computed is read back out of the slot
1942    /// it was written to rather than left on the stack, which costs a store and a load per
1943    /// instruction in an expression. Keeping a partial result on the stack across the next
1944    /// instruction's operands means knowing how deep the stack is at every point in the block, and
1945    /// that is a different thing from writing a group.
1946    fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
1947        let (args, result) = self.ends(inst)?;
1948        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
1949        let span = self.source.span(inst);
1950        let left = self.x87_slot(left);
1951        let left = self.through(left);
1952        let right = self.x87_slot(right);
1953        let right = self.through(right);
1954        let into = self.x87_slot(result);
1955        let into = self.through(into);
1956        self.x87_at("fld_t", span, left);
1957        self.x87_at("fld_t", span, right);
1958        self.x87_only(with, span);
1959        self.x87_at("fstp_t", span, into);
1960        Ok(())
1961    }
1962
1963    /// A negation, which is a push, the sign bit turned over and a pop.
1964    ///
1965    /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
1966    /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
1967    /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
1968    /// negative zero and a signalling one at a NaN.
1969    fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
1970        let (args, result) = self.ends(inst)?;
1971        let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
1972        let span = self.source.span(inst);
1973        let from = self.x87_slot(source);
1974        let from = self.through(from);
1975        let into = self.x87_slot(result);
1976        let into = self.through(into);
1977        self.x87_at("fld_t", span, from);
1978        self.x87_only("fchs", span);
1979        self.x87_at("fstp_t", span, into);
1980        Ok(())
1981    }
1982
1983    /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
1984    ///
1985    /// The right operand is pushed first and the left one on top of it, which is the other way
1986    /// round from the arithmetic and is because `fucomip` asks about the top against what is under
1987    /// it: the comparison this machine can do is the top's, so the value the predicate is about
1988    /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
1989    /// flags are both inside the opcode, since what passes between those and the comparison is the
1990    /// flags and the flags are not something anything here can name.
1991    ///
1992    /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
1993    /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
1994    /// picked a different condition here than there would be a `long double` comparison that
1995    /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
1996    /// wider format is not allowed to do.
1997    ///
1998    /// The always false and the always true are refused rather than folded into a constant,
1999    /// because a comparison this machine never has to do is one the optimizer should have removed
2000    /// and an instruction here that quietly agreed with it would hide that it did not.
2001    fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2002        let Extra::FloatPred(pred) = self.source[inst].extra else {
2003            return Err(self.unsupported(inst));
2004        };
2005        let (args, result) = self.ends(inst)?;
2006        let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2007        // Two of the fourteen need a second byte and an instruction to put the two together,
2008        // because they are two conditions at once: an ordered equal is equal and not unordered,
2009        // and an unordered not equal is either. The opcode carries all of that and says here only
2010        // that it writes somewhere else as well.
2011        let (name, reversed, both) = match pred {
2012            FloatPred::Ogt => ("fucomip_set_a", false, false),
2013            FloatPred::Oge => ("fucomip_set_ae", false, false),
2014            FloatPred::Olt => ("fucomip_set_a", true, false),
2015            FloatPred::Ole => ("fucomip_set_ae", true, false),
2016            FloatPred::One => ("fucomip_set_ne", false, false),
2017            FloatPred::Ord => ("fucomip_set_np", false, false),
2018            FloatPred::Uno => ("fucomip_set_p", false, false),
2019            FloatPred::Ueq => ("fucomip_set_e", false, false),
2020            FloatPred::Ult => ("fucomip_set_b", false, false),
2021            FloatPred::Ule => ("fucomip_set_be", false, false),
2022            FloatPred::Ugt => ("fucomip_set_b", true, false),
2023            FloatPred::Uge => ("fucomip_set_be", true, false),
2024            FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2025            FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2026            FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2027        };
2028        let (top, under) = if reversed { (right, left) } else { (left, right) };
2029
2030        let span = self.source.span(inst);
2031        let gpr = self.gpr;
2032        let under = self.x87_slot(under);
2033        let under = self.through(under);
2034        let top = self.x87_slot(top);
2035        let top = self.through(top);
2036        self.x87_at("fld_t", span, under);
2037        self.x87_at("fld_t", span, top);
2038
2039        let block = self.at.expect("a block is being filled");
2040        let reg = self.new_reg(result);
2041        // Taken before the instruction is started rather than inside it, since both come from the
2042        // same function being built and only one thing at a time may be adding to it.
2043        let spare = both.then(|| self.out.new_vreg(gpr));
2044        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2045        let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2046        if let Some(spare) = spare {
2047            build = build.def(spare, gpr);
2048        }
2049        build.finish();
2050        Ok(())
2051    }
2052
2053    /// The operands and the one result of an instruction that has exactly one.
2054    fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2055        let data = &self.source[inst];
2056        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2057        Ok((&self.source[data.args], result))
2058    }
2059
2060    /// The operand of a conversion, which is the end of it that is not the `long double`.
2061    fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2062        let args = &self.source[self.source[inst].args];
2063        args.first().copied().ok_or_else(|| self.unsupported(inst))
2064    }
2065
2066    /// One `va_start`, as the fields of the list it was handed.
2067    ///
2068    /// On the four field list, two of them are numbers this already knows, and each costs an
2069    /// instruction to put in a register before it can be stored, because the machine here has no
2070    /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2071    /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2072    /// and the caller's argument area is where the parameters that had no register came from, which
2073    /// is the same place and the same fixup a parameter past the sixth already uses.
2074    ///
2075    /// On the list that is a pointer it is the second of those four and nothing else, since the
2076    /// whole of what that list says is where the walk is and the walk starts at the first argument
2077    /// the signature does not name. One `lea` and one store.
2078    ///
2079    /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2080    /// laid out, so that reading this beside that table is the whole of the check.
2081    fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2082        let Some(&list) = self.source[self.source[inst].args].first() else {
2083            return Err(self.unsupported(inst));
2084        };
2085        let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2086        let list = self.reg_of(list)?;
2087        let block = self.at.expect("a block is being filled");
2088        let span = self.source.span(inst);
2089
2090        let (save, incoming) = match started {
2091            Varargs::Pointer { incoming } => (None, incoming),
2092            Varargs::Fields { save, incoming, integers, floats } => {
2093                for (at, count) in [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)] {
2094                    let held = self.out.new_vreg(self.gpr);
2095                    let load = mir::Opcode::new(self.names.intern("x64.mov_ri_32"));
2096                    let build = self.out.build(block, load).at(span);
2097                    build.def(held, self.gpr).imm(i64::from(count)).finish();
2098
2099                    let store = mir::Opcode::new(self.names.intern("x64.mov_mr_32"));
2100                    let mem = self.field(list, at);
2101                    self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2102                }
2103                (Some(save), incoming)
2104            }
2105        };
2106
2107        // The first argument the signature did not name, which is as far up the caller's argument
2108        // area as the ones it did name reached. Nothing here knows where that area is, so the
2109        // distance is recorded the way a parameter read out of it is and finished with it.
2110        let overflow = self.out.new_vreg(self.gpr);
2111        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
2112        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2113        let made = self
2114            .out
2115            .build(block, lea)
2116            .at(span)
2117            .def(overflow, self.gpr)
2118            .mem(mir::Mem::at(sp))
2119            .finish();
2120        self.stack.arguments.push((made, incoming));
2121
2122        // At the front of the list when that address is the whole of it, and at the field the
2123        // layout gives it when there are four, with the save area behind it.
2124        let fields = match save {
2125            None => vec![(0, overflow)],
2126            Some(save) => {
2127                let save = self.frame_address(block, save);
2128                vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2129            }
2130        };
2131        for (at, held) in fields {
2132            let store = mir::Opcode::new(self.names.intern("x64.mov_mr_64"));
2133            let mem = self.field(list, at);
2134            self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2135        }
2136        Ok(())
2137    }
2138
2139    /// One field of a list, as the addressing mode that reaches it.
2140    fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2141        let base = mir::Operand::read(list, self.gpr);
2142        mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2143    }
2144
2145    /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2146    ///
2147    /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2148    /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2149    /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2150    /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2151    /// the encoder emits the relocation, because a call to a name the file does not define needed
2152    /// them first.
2153    ///
2154    /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2155    /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2156    /// this program can work out, and the address of a function this file merely declares is not
2157    /// such a number. The load reads the address out of the slot the linker fills in instead. The
2158    /// linker turns it back into the `lea` when the name turns out to have been here all along,
2159    /// so this is not slower in the case that was already right.
2160    ///
2161    /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2162    /// being folded into the instruction that reads it. Folding it is the right thing to do and
2163    /// is what turns a load of a global from two instructions into one, but it is a separate
2164    /// question about addressing modes and issue #282 is it. Until then the address is in a
2165    /// register before anything uses it, which is correct and one instruction longer.
2166    ///
2167    /// What this does not do is give the name anything to refer to. A module carries its globals
2168    /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2169    /// reference the linker cannot resolve. Issue #293 is the other half.
2170    ///
2171    /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2172    fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2173        let data = &self.source[inst];
2174        let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2175        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2176        if self.elsewhere.thread(symbol) {
2177            return self.thread_address(inst, symbol, result);
2178        }
2179
2180        let block = self.at.expect("a block is being filled");
2181        let reg = self.new_reg(result);
2182        let span = self.source.span(inst);
2183        let (mnemonic, mem) = if self.elsewhere.holds(symbol) {
2184            (GOT_LOAD, mir::Mem::got(symbol))
2185        } else {
2186            (x86_64::FRAME.lea, mir::Mem::of(symbol))
2187        };
2188        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{mnemonic}")));
2189        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2190        Ok(())
2191    }
2192
2193    /// The address of a thread-local variable, which is this thread's copy of it.
2194    ///
2195    /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2196    /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2197    /// thread and they are at different addresses, so a link asked for the distance to the name
2198    /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2199    /// the same reason.
2200    ///
2201    /// What is the same in every thread is where the variable sits inside the block of storage a
2202    /// thread gets, so that offset is what the link writes down, and the address of the running
2203    /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2204    /// front of the block, so the whole of this is three instructions:
2205    ///
2206    /// ```text
2207    /// movq  x@gottpoff(%rip), %off   # how far into the block x sits, which the link fills in
2208    /// movq  %fs:0, %tp               # where this thread's block is, which only the machine knows
2209    /// addq  %tp, %off                # this thread's copy of x
2210    /// ```
2211    ///
2212    /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2213    /// in an executable, which folds the addition into the instruction that uses the address, and
2214    /// the difference is issue #282 rather than anything about threads: nothing here folds an
2215    /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2216    /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2217    /// table slot costs nothing in the case that is common.
2218    ///
2219    /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2220    /// program is already running, and the block this reaches was laid out before it started, so
2221    /// the loader has to find room in that block for the library's variables. glibc keeps a little
2222    /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2223    /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2224    /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2225    ///
2226    /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2227    /// right for a library the program is linked against, and a load that either works or is
2228    /// refused out loud for a library something opens later. What it is never is quietly wrong.
2229    fn thread_address(
2230        &mut self,
2231        inst: Inst,
2232        symbol: Symbol,
2233        result: Value,
2234    ) -> Result<(), Unsupported> {
2235        let block = self.at.expect("a block is being filled");
2236        let span = self.source.span(inst);
2237        let gpr = self.gpr;
2238        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{GOT_LOAD}")));
2239
2240        let offset = self.out.new_vreg(gpr);
2241        self.out
2242            .build(block, load)
2243            .at(span)
2244            .def(offset, gpr)
2245            .mem(mir::Mem::thread(symbol))
2246            .finish();
2247        // The front of the block, which is the one thing on this machine that no instruction can
2248        // work out: `%fs` is not a register a program can read, and what it points at is a word
2249        // holding its own address, so reading through it at zero is how the address is come by.
2250        let pointer = self.out.new_vreg(gpr);
2251        let at = mir::Mem::in_segment(Segment::Fs, 0);
2252        self.out.build(block, load).at(span).def(pointer, gpr).mem(at).finish();
2253
2254        // Two address, spelled out for the reason `x87_to_int` gives: this machine adds into the
2255        // register it read, and only the constraint says the two are the same one.
2256        let reg = self.new_reg(result);
2257        let add = mir::Opcode::new(self.names.intern(&format!("{PREFIX}add_rr_64")));
2258        self.out
2259            .build(block, add)
2260            .at(span)
2261            .operand(mir::Operand::write(reg, gpr).with(Constraint::Reuse(1)))
2262            .operand(mir::Operand::read(offset, gpr))
2263            .operand(mir::Operand::read(pointer, gpr))
2264            .finish();
2265        Ok(())
2266    }
2267
2268    /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
2269    /// in this same function.
2270    ///
2271    /// What the two have in common is the whole of the instruction: an address worked out from
2272    /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
2273    /// reaches anything. What they do not have in common is what fills the four bytes in. A
2274    /// global is a name, so the number is a relocation and the linker writes it. A block is a
2275    /// place in this function, so both ends are in one section and the number is known as soon as
2276    /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
2277    /// jump rather than leaving a relocation behind.
2278    ///
2279    /// Nothing here says the block is one control can arrive at. That is said by the
2280    /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
2281    /// and by nothing else: an address on its own is a number.
2282    fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
2283        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2284        let Some(call) = self.source.successors(inst).next() else {
2285            return Err(self.unsupported(inst));
2286        };
2287        let block = self.at.expect("a block is being filled");
2288        let reg = self.new_reg(result);
2289        let span = self.source.span(inst);
2290        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
2291        let mem = mir::Mem::block(self.out_block(call.block));
2292        self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2293        Ok(())
2294    }
2295
2296    /// `goto *p`, GNU's computed goto, which is a jump through a register.
2297    ///
2298    /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
2299    /// block this ends, the way every other arm is, and which of them the address holds is decided
2300    /// while the program runs. So this is one instruction with one operand, and the arms are
2301    /// copied across by [`Self::edges`] like anybody else's.
2302    fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
2303        let data = &self.source[inst];
2304        let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2305        let reg = self.reg_of(address)?;
2306        let block = self.at.expect("a block is being filled");
2307        let span = self.source.span(inst);
2308        let name = x86_64::BRANCH.indirect;
2309        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2310        self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
2311        Ok(())
2312    }
2313
2314    /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
2315    /// somewhere else can bring control back here, and answers zero on the way past.
2316    ///
2317    /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
2318    /// block ends: everything after the save in the IR block is put into a new machine IR block,
2319    /// and the address of that block is what went into the buffer. That is the whole reason the
2320    /// block is split here. An address points at a label, a machine IR block is the only thing in
2321    /// this representation that has one, and a save is in the middle of a block rather than at the
2322    /// end of one.
2323    ///
2324    /// # How the answer gets back
2325    ///
2326    /// Through the frame rather than through a register. The save writes a zero into a word of its
2327    /// own frame, puts the address of that word in the buffer, and the new block reads the word
2328    /// back. The restore writes a one through the address it finds in the buffer before it goes.
2329    /// So one load answers zero on the way past and one on the way back, and neither path has to
2330    /// agree with the other about a register.
2331    ///
2332    /// gcc does it the other way round, with a second block that sets the answer to one and is
2333    /// what the restore arrives at. That block is one nothing in the function jumps to, and a
2334    /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
2335    /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
2336    /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
2337    /// and it needs nothing said anywhere about a block arrived at from outside.
2338    ///
2339    /// # What the allocator is told
2340    ///
2341    /// That every register it hands out is gone at the end of the first block. That is what makes
2342    /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
2343    /// in some other function, and the only two registers that puts back are the stack pointer and
2344    /// the frame pointer, so anything this function still wants has to be in the frame those two
2345    /// reach. It is said with a write of every one of those registers, which is the same thing a
2346    /// call says about the registers a callee may destroy, on an instruction with nothing else on
2347    /// it so that the stores above are not caught up in it.
2348    fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
2349        let data = &self.source[inst];
2350        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2351        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2352        let span = self.source.span(inst);
2353        let buf = self.reg_of(buffer)?;
2354        let at = self.at.expect("a block is being filled");
2355        let gpr = self.gpr;
2356        let moves = x86_64::FRAME.moves(gpr).expect("a class the target says how to move");
2357        let store = self.named(moves.store);
2358        let load = self.named(moves.load);
2359        let lea = self.named(x86_64::FRAME.lea);
2360        let put = self.named(x86_64::FRAME.imm);
2361        let nothing = x86_64::FRAME.pad.expect("a target with an instruction that does nothing");
2362        let nothing = self.named(nothing);
2363        self.stack.saves_place = true;
2364        let answer = self.answer_slot();
2365        let back = self.out.create_block();
2366
2367        // The zero this answers with, into the word a restore writes a one into.
2368        let zero = self.out.new_vreg(gpr);
2369        self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
2370        let mem = self.frame_mem();
2371        let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
2372        self.stack.addresses.push((made, answer));
2373
2374        // The four words: where that word is, where control comes back to, and the two registers
2375        // the restore puts back.
2376        let found = self.frame_address(at, answer);
2377        self.write_word(at, span, store, found, buf, JUMP_ANSWER);
2378        let pc = self.out.new_vreg(gpr);
2379        self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
2380        self.write_word(at, span, store, pc, buf, JUMP_PC);
2381        let frame = mir::Reg::physical(self.conv.frame_pointer);
2382        self.write_word(at, span, store, frame, buf, JUMP_FRAME);
2383        let stack = mir::Reg::physical(self.conv.stack_pointer);
2384        self.write_word(at, span, store, stack, buf, JUMP_STACK);
2385
2386        // Nothing is in a register past this point, which is what the rest of the function is
2387        // allowed to assume about the way back in.
2388        let gone = self.across_jump();
2389        let mut build = self.out.build(at, nothing).at(span);
2390        for (reg, class) in gone {
2391            build = build.operand(mir::Operand::write(reg, class));
2392        }
2393        build.finish();
2394
2395        // And the rest of the block, which is the block the address above was of.
2396        *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
2397        self.at = Some(back);
2398        let reg = self.new_reg(result);
2399        let mem = self.frame_mem();
2400        let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
2401        self.stack.addresses.push((made, answer));
2402        Ok(())
2403    }
2404
2405    /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
2406    ///
2407    /// Everything comes out of the buffer before anything is put back, and the four registers it
2408    /// comes out into are physical ones rather than values the allocator places. Both of those are
2409    /// about the same moment. The stack pointer is one of the things being put back, a value the
2410    /// allocator sent to the stack is reached through the stack pointer, and between the
2411    /// instruction that moves it and the jump there is no stack this function owns any more. A
2412    /// register named outright is a register nothing reloads into and nothing else is in, which is
2413    /// the only way to hold something across that moment.
2414    ///
2415    /// Four of them because that is how many things are in the air at once: where to go, the frame
2416    /// pointer to put back, the one the matching save is to answer with, and one register used
2417    /// twice, first for the address that one is written through and then for the stack pointer.
2418    ///
2419    /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
2420    /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
2421    /// written out and never run.
2422    fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
2423        let data = &self.source[inst];
2424        let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2425        let span = self.source.span(inst);
2426        let buf = self.reg_of(buffer)?;
2427        let at = self.at.expect("a block is being filled");
2428        let gpr = self.gpr;
2429        let moves = x86_64::FRAME.moves(gpr).expect("a class the target says how to move");
2430        let load = self.named(moves.load);
2431        let store = self.named(moves.store);
2432        let mov = self.named(moves.mov);
2433        let put = self.named(x86_64::FRAME.imm);
2434        let jump = self.named(x86_64::BRANCH.indirect);
2435
2436        let held = self.jump_regs();
2437        if held.len() < JUMP_REGS {
2438            return Err(self.unsupported(inst));
2439        }
2440        let pc = mir::Reg::physical(held[0]);
2441        let frame = mir::Reg::physical(held[1]);
2442        let spare = mir::Reg::physical(held[2]);
2443        let one = mir::Reg::physical(held[3]);
2444
2445        self.read_word(at, span, load, pc, buf, JUMP_PC);
2446        self.read_word(at, span, load, frame, buf, JUMP_FRAME);
2447        self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
2448
2449        // What the matching save answers with, written through the address that came out of the
2450        // buffer, because the word it goes in is in the other function's frame and this one has no
2451        // way of knowing where that is.
2452        self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
2453        let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
2454        self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
2455
2456        // The stack last of the four, so that the register the buffer is reached through is done
2457        // with before the stack it may have been spilled to stops being this function's.
2458        self.read_word(at, span, load, spare, buf, JUMP_STACK);
2459        let stack = mir::Reg::physical(self.conv.stack_pointer);
2460        self.copy(at, span, mov, stack, spare);
2461        let base = mir::Reg::physical(self.conv.frame_pointer);
2462        self.copy(at, span, mov, base, frame);
2463
2464        // And the jump, which reads the two registers just put back as well as the address it
2465        // goes through. Neither of those is printed, because the target's spelling of an indirect
2466        // jump has one argument and it is the first one read. They are there because the code
2467        // control arrives at reaches its frame through them, and because without them the two
2468        // instructions above write registers nothing reads: a scheduler is then free to put the
2469        // jump in front of them, and at `-O2` it does.
2470        self.out
2471            .build(at, jump)
2472            .at(span)
2473            .operand(mir::Operand::read(pc, gpr))
2474            .operand(mir::Operand::read(stack, gpr))
2475            .operand(mir::Operand::read(base, gpr))
2476            .finish();
2477        Ok(())
2478    }
2479
2480    /// One word of the buffer of a `__builtin_setjmp`, written from a register.
2481    fn write_word(
2482        &mut self,
2483        at: mir::Block,
2484        span: Span,
2485        store: mir::Opcode,
2486        from: mir::Reg,
2487        buf: mir::Reg,
2488        word: i32,
2489    ) {
2490        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
2491        self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
2492    }
2493
2494    /// One word of that buffer, read back into a register.
2495    fn read_word(
2496        &mut self,
2497        at: mir::Block,
2498        span: Span,
2499        load: mir::Opcode,
2500        into: mir::Reg,
2501        buf: mir::Reg,
2502        word: i32,
2503    ) {
2504        let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
2505        self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
2506    }
2507
2508    /// One register into another, which is the one shape of instruction the builder has no word
2509    /// for because neither operand is a definition of a value or a read of memory.
2510    fn copy(
2511        &mut self,
2512        at: mir::Block,
2513        span: Span,
2514        mov: mir::Opcode,
2515        into: mir::Reg,
2516        from: mir::Reg,
2517    ) {
2518        self.out
2519            .build(at, mov)
2520            .at(span)
2521            .operand(mir::Operand::write(into, self.gpr))
2522            .operand(mir::Operand::read(from, self.gpr))
2523            .finish();
2524    }
2525
2526    /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
2527    fn answer_slot(&mut self) -> usize {
2528        match self.answer {
2529            Some(index) => index,
2530            None => {
2531                let index = self.stack.locals.len();
2532                self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
2533                self.answer = Some(index);
2534                index
2535            }
2536        }
2537    }
2538
2539    /// An address in this function's frame with nothing in its displacement, which is what an
2540    /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
2541    /// where the object is.
2542    fn frame_mem(&self) -> mir::Mem {
2543        mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
2544    }
2545
2546    /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
2547    ///
2548    /// Both files, since a `double` live across a save has the same problem an integer does. The
2549    /// two registers a frame is reached through are not here: the restore puts both of them back,
2550    /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
2551    /// by its own save would have nothing left to find its caller with.
2552    fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
2553        let mut gone = Vec::new();
2554        for &reg in self.conv.int_order {
2555            if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
2556                continue;
2557            }
2558            gone.push((mir::Reg::physical(reg), self.gpr));
2559        }
2560        for &reg in self.conv.sse_order {
2561            gone.push((mir::Reg::physical(reg), self.conv.sse_class));
2562        }
2563        gone
2564    }
2565
2566    /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
2567    ///
2568    /// The ones the allocator hands out, less the two a frame is reached through. The scratch
2569    /// registers are not among them on purpose: the rewriter writes a reload into one of those
2570    /// wherever it likes, and one of these has to survive from the load that fills it to the
2571    /// instruction that reads it however many instructions apart those are.
2572    fn jump_regs(&self) -> Vec<PhysReg> {
2573        self.conv
2574            .int_order
2575            .iter()
2576            .copied()
2577            .filter(|&reg| {
2578                reg != self.conv.stack_pointer
2579                    && reg != self.conv.frame_pointer
2580                    && !crate::pipeline::SCRATCH.contains(&reg)
2581            })
2582            .collect()
2583    }
2584
2585    /// A machine opcode of this target from the name the target gives it.
2586    fn named(&mut self, name: &str) -> mir::Opcode {
2587        mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")))
2588    }
2589
2590    /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
2591    /// saved frame pointers and then one thing read at the end of it.
2592    ///
2593    /// Every frame that kept a frame pointer holds the caller's at the address the register points
2594    /// at, and the address that frame returns to one word above that, which is where the call
2595    /// instruction put it and where the prologue's push left it. So the walk is a load through the
2596    /// register for each link, the frame address is wherever the walk stopped, and the return
2597    /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
2598    /// x86-64 at `-O2` for depths zero to three of both builtins.
2599    ///
2600    /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
2601    /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
2602    /// needs it as the start, so there is no case here where it is not wanted.
2603    ///
2604    /// How far the chain actually reaches is the program's business and not this one's. A caller
2605    /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
2606    /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
2607    /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
2608    /// `check/builtin/frame.rs` rather than walked as far as it says.
2609    fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
2610        let data = &self.source[inst];
2611        let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
2612        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2613        let returning = data.opcode == Opcode::ReturnAddress;
2614        let block = self.at.expect("a block is being filled");
2615        let span = self.source.span(inst);
2616        let moves = x86_64::FRAME.moves(self.gpr).expect("a class the target says how to move");
2617        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", moves.load)));
2618        self.stack.walks_frames = true;
2619
2620        // Where the walk is up to. The frame pointer to begin with, and the register the last load
2621        // wrote after that.
2622        let reg = self.new_reg(result);
2623        let mut base = mir::Reg::physical(self.conv.frame_pointer);
2624        for link in 0..depth {
2625            // The last load of a walk that is looking for a frame writes the answer itself, which
2626            // is what keeps a walk of so many links that many instructions and not one more.
2627            let ends_here = link + 1 == depth && !returning;
2628            let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
2629            let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
2630            self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
2631            base = next;
2632        }
2633
2634        if returning {
2635            let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
2636            let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
2637            self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
2638        } else if depth == 0 {
2639            // The one case with no load in it at all: the frame this function is running in is the
2640            // register itself, and a physical register is not one the allocator hands out, so the
2641            // answer is a copy of it.
2642            let mov = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", moves.mov)));
2643            self.out
2644                .build(block, mov)
2645                .at(span)
2646                .operand(mir::Operand::write(reg, self.gpr))
2647                .operand(mir::Operand::read(base, self.gpr))
2648                .finish();
2649        }
2650        Ok(())
2651    }
2652
2653    /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
2654    /// an offset to.
2655    ///
2656    /// The same one instruction, on its own this time and with nothing to add to it. A program
2657    /// writes this when what it wants is a number that is different in every thread and cheap to
2658    /// come by, rather than a variable of its own in the block, so there is no relocation here and
2659    /// no name for the link to resolve.
2660    fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
2661        let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2662        let block = self.at.expect("a block is being filled");
2663        let span = self.source.span(inst);
2664        let reg = self.new_reg(result);
2665        let load = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{GOT_LOAD}")));
2666        let at = mir::Mem::in_segment(Segment::Fs, 0);
2667        self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
2668        Ok(())
2669    }
2670
2671    /// A conversion that converts nothing: the result is the operand under another type.
2672    ///
2673    /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
2674    /// an integer as wide as the machine addresses, so a cast between the two changes what the
2675    /// type system calls the value and changes nothing about the value, and the register holding
2676    /// it is the register that already held it. The front end never writes either of them at any
2677    /// other width, because it widens or narrows around the cast rather than through it, so the
2678    /// two widths disagreeing here means the IR came from somewhere else and is refused rather
2679    /// than guessed at.
2680    ///
2681    /// Reading the operand first is what materializes it when it is a constant, which is the case
2682    /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
2683    /// register before anything can call it an address.
2684    fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
2685        let data = &self.source[inst];
2686        let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
2687        let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2688        if !self.is_address_width(self.source[arg].ty)
2689            || !self.is_address_width(self.source[result].ty)
2690        {
2691            return Err(self.unsupported(inst));
2692        }
2693        let reg = self.reg_of(arg)?;
2694        self.regs[result.index()] = Some(reg);
2695        Ok(())
2696    }
2697
2698    /// One barrier, which on this machine is one instruction at the strongest ordering and no
2699    /// instruction at all at every other one.
2700    ///
2701    /// x86-64 is total store order, so the only reordering the machine does is a store followed by
2702    /// a load of a different address, and the only ordering that forbids that is sequential
2703    /// consistency. An acquire, a release and an acquire release fence are therefore already true
2704    /// of every program running here, and what a program wanted from writing one is that the
2705    /// compiler not move memory accesses across it. The optimizer has finished by the time this
2706    /// runs and nothing below reorders one access past another, so the constraint is already
2707    /// discharged and there is nothing to write.
2708    ///
2709    /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
2710    /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
2711    /// on the stack is faster on most parts and is what some compilers write instead; it is also a
2712    /// write to memory the program did not ask for, and the plain barrier is the one that says what
2713    /// it means.
2714    ///
2715    /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
2716    /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
2717    /// nothing, so there is no equality to state, and what makes it the right answer is the memory
2718    /// model, which the rule language cannot talk about.
2719    fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
2720        let Extra::Order(order) = self.source[inst].extra else {
2721            return Err(self.unsupported(inst));
2722        };
2723        if order != MemOrder::SeqCst {
2724            return Ok(());
2725        }
2726        let block = self.at.expect("a block is being filled");
2727        let span = self.source.span(inst);
2728        let fence = mir::Opcode::new(self.names.intern("x64.mfence"));
2729        self.out.build(block, fence).at(span).finish();
2730        Ok(())
2731    }
2732
2733    /// The instruction a program stops on, which is one byte pair and no operands.
2734    ///
2735    /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
2736    /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
2737    /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
2738    /// caught by anything the program installed for an ordinary error, cannot be returned from,
2739    /// and leaves the address of the fault in the core file.
2740    ///
2741    /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
2742    /// library, and it works in the places this one is written most, which are a kernel and a
2743    /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
2744    fn trap(&mut self, inst: Inst) {
2745        let block = self.at.expect("a block is being filled");
2746        let span = self.source.span(inst);
2747        let stop = mir::Opcode::new(self.names.intern("x64.ud2"));
2748        self.out.build(block, stop).at(span).finish();
2749    }
2750
2751    /// One hint that an address is about to be used, which is one instruction and no promise.
2752    ///
2753    /// Four instructions on this machine and the locality picks between them, which is what the
2754    /// number means: how much of the data will still be wanted after the access. None of it wanted
2755    /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
2756    /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
2757    /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
2758    /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
2759    ///
2760    /// Whether the access will write is not read here, and that is this machine rather than an
2761    /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
2762    /// writes it only when the command line said the part has it. So a prefetch for a write is the
2763    /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
2764    /// `-mprfchw`, and the difference is carried in the IR for a target that can use it.
2765    ///
2766    /// The address goes in the addressing mode rather than in an operand, the way a store's does.
2767    /// It is built here as the plainest one there is, a register and nothing else, because what
2768    /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
2769    /// this instruction. An address the program computed is therefore one `lea` or one add in front
2770    /// of this, which is what it would have been for the load the hint is about anyway.
2771    fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
2772        let Extra::Prefetch(hint) = self.source[inst].extra else {
2773            return Err(self.unsupported(inst));
2774        };
2775        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
2776        let [address] = args[..] else { return Err(self.unsupported(inst)) };
2777        let name = match hint.locality {
2778            0 => "prefetch_nta",
2779            1 => "prefetch_t2",
2780            2 => "prefetch_t1",
2781            PrefetchHint::MOST => "prefetch_t0",
2782            // Nothing else exists. The checker reads a locality outside the range as zero and the
2783            // verifier refuses one that got here another way, so this is a hint that was built
2784            // rather than checked, and the safe answer for a hint is to write no instruction.
2785            _ => return Err(self.unsupported(inst)),
2786        };
2787        let base = self.reg_of(address)?;
2788        let block = self.at.expect("a block is being filled");
2789        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2790        self.out
2791            .build(block, opcode)
2792            .at(self.source.span(inst))
2793            .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
2794            .finish();
2795        Ok(())
2796    }
2797
2798    /// One compare and exchange, which is the instruction every other atomic on this machine is
2799    /// built out of.
2800    ///
2801    /// What the IR asks for is: read what is at an address, compare it against a value the program
2802    /// expected, put a second value there if the two were equal, and say both what was read and
2803    /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
2804    /// front of it is what makes the whole of it one step as far as every other processor is
2805    /// concerned.
2806    ///
2807    /// The ordering is not read here, and that is the memory model rather than an omission. A
2808    /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
2809    /// compare and exchange and a sequentially consistent one are the same instruction, and there
2810    /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
2811    /// same reason.
2812    ///
2813    /// The two values it produces are why this is written by name. The one the program compares
2814    /// against and the one it gets back are both `rax`, which the instruction reads and writes
2815    /// without being told, and the table says so with a fixed constraint at each end rather than
2816    /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
2817    /// flag read out by a `sete`, and it is a definition of the same instruction so that the
2818    /// allocator knows the two are live together and never gives the byte the register the answer
2819    /// is in.
2820    fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
2821        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
2822        let results: Vec<Value> = self.source[inst].results().collect();
2823        let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
2824        let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
2825
2826        // A value the machine can compare in one instruction, which is an integer or an address at
2827        // one of the four widths it has a compare and exchange for. Anything else is a type this
2828        // has no instruction for rather than a program that is wrong, and the front end refuses it
2829        // before ever getting here.
2830        let ty = self.source[old].ty;
2831        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
2832        if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
2833            return Err(self.unsupported(inst));
2834        }
2835
2836        let base = self.reg_of(addr)?;
2837        let want = self.reg_of(expected)?;
2838        let put = self.reg_of(desired)?;
2839        let got = self.new_reg(old);
2840        let flag = self.new_reg(exchanged);
2841
2842        let name = format!("cmpxchg_{bits}");
2843        let form = x86_64::form(&name).ok_or_else(|| self.unsupported(inst))?;
2844        let block = self.at.expect("a block is being filled");
2845        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2846        let (span, flags) = (self.source.span(inst), self.carried(inst));
2847        let mut build = self.out.build(block, opcode).at(span).flags(flags);
2848        for (desc, reg) in form.operands().iter().zip([got, flag, want, put]) {
2849            let operand = mir::Operand {
2850                reg,
2851                class: desc.class,
2852                role: desc.role,
2853                constraint: desc.constraint,
2854            };
2855            build = build.operand(operand);
2856        }
2857        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
2858        Ok(())
2859    }
2860
2861    /// One read modify write, for the three operations this machine does in a single instruction.
2862    ///
2863    /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
2864    /// say what was there before, and let nothing get between the three steps. The machine has
2865    /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
2866    /// found in the register the operand arrived in, which is why the value that comes back and the
2867    /// value that went in are one register here.
2868    ///
2869    /// A subtraction is the add over the negated operand, which is right at every width because the
2870    /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
2871    /// whatever the operands were. The negate is a separate instruction in front, over a register of
2872    /// its own, so that the value the program handed over is not the one written on: an operand may
2873    /// be live after this and a program that read it again would read the negation.
2874    ///
2875    /// The ordering is not read, for the reason the compare and exchange beside this does not read
2876    /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
2877    /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
2878    ///
2879    /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
2880    /// around a compare and exchange before anything here saw it. The two that do arrive are the
2881    /// ones on floating values, and they are refused: a compare and exchange of a float wants the
2882    /// value carried through an integer of the same width, and an eighty bit float has no such
2883    /// width. Neither family of builtins can write one yet either, so a program that reaches this
2884    /// refusal is a program that reached an unimplemented builtin first.
2885    fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
2886        let Extra::Rmw(op, _) = self.source[inst].extra else {
2887            return Err(self.unsupported(inst));
2888        };
2889        let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
2890        let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
2891        let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2892
2893        // A value the machine can exchange in one instruction, which is an integer at one of the
2894        // four widths it has these for. A pointer arrives as an address, so it is an integer by the
2895        // time it is here, and anything else is a type this has no instruction for.
2896        let ty = self.source[old].ty;
2897        if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
2898            return Err(self.unsupported(inst));
2899        }
2900        let name = match op {
2901            RmwOp::Xchg => format!("xchg_{}", ty.bits()),
2902            RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
2903            _ => return Err(self.unsupported(inst)),
2904        };
2905
2906        let base = self.reg_of(addr)?;
2907        let mut put = self.reg_of(operand)?;
2908        let block = self.at.expect("a block is being filled");
2909        let span = self.source.span(inst);
2910        if op == RmwOp::Sub {
2911            let negated = self.out.new_vreg(self.gpr);
2912            let negate =
2913                mir::Opcode::new(self.names.intern(&format!("{PREFIX}neg_r_{}", ty.bits())));
2914            let form = x86_64::form(&format!("neg_r_{}", ty.bits()))
2915                .ok_or_else(|| self.unsupported(inst))?;
2916            let mut build = self.out.build(block, negate).at(span);
2917            for (desc, reg) in form.operands().iter().zip([negated, put]) {
2918                build = build.operand(mir::Operand {
2919                    reg,
2920                    class: desc.class,
2921                    role: desc.role,
2922                    constraint: desc.constraint,
2923                });
2924            }
2925            build.finish();
2926            put = negated;
2927        }
2928
2929        let got = self.new_reg(old);
2930        let form = x86_64::form(&name).ok_or_else(|| self.unsupported(inst))?;
2931        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{name}")));
2932        let flags = self.carried(inst);
2933        let mut build = self.out.build(block, opcode).at(span).flags(flags);
2934        for (desc, reg) in form.operands().iter().zip([got, put]) {
2935            build = build.operand(mir::Operand {
2936                reg,
2937                class: desc.class,
2938                role: desc.role,
2939                constraint: desc.constraint,
2940            });
2941        }
2942        build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
2943        Ok(())
2944    }
2945
2946    /// One `asm` statement.
2947    ///
2948    /// An empty template is most of the inline assembly in a test suite, and it is not a corner
2949    /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
2950    /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
2951    /// years of bug reports about optimizers are full of them. What such a statement asks for is
2952    /// the barrier and the operand places, and no instructions at all.
2953    ///
2954    /// So the operands are the half that is always real: a constraint says where a value has to be,
2955    /// and where it has to be is still true when the template between them is empty.
2956    ///
2957    /// What the constraints ask for, on an empty template, is only ever that two operands share a
2958    /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
2959    /// no particular one, and any register at all answers it. A matching constraint is different,
2960    /// because it says the output the assembly leaves is the place the input arrived in, and with
2961    /// no instructions between them that is the input unchanged. So it is a rename and not a move:
2962    /// the value is already in a register and the result is that register.
2963    ///
2964    /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
2965    /// which for a template that writes nothing is whatever was in the register. That is a value
2966    /// the program is not entitled to, and this writes a zero rather than reading one, because the
2967    /// allocator has to be given a definition before a use whatever the program is entitled to.
2968    ///
2969    /// # A template with instructions in it
2970    ///
2971    /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
2972    /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
2973    /// instruction a program wrote is looked up in that description rather than copied through to
2974    /// an assembler that has one of its own. So nothing here assembles anything. What it does is
2975    /// put the statement's operands where the opcode holds them, and from there an `asm` statement
2976    /// is ordinary machine code: the allocator picks the registers, the listing and the object file
2977    /// are written from the same table as every other instruction, and a spill around one works
2978    /// because there is nothing left about it for a spill to get wrong.
2979    ///
2980    /// A register the template named in its own text is the one thing in there that is nobody's
2981    /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
2982    /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
2983    ///
2984    /// Two things are refused, both for one reason, which is that placing them by a guess gives a
2985    /// program that assembles into something other than what it says.
2986    ///
2987    /// An output the template writes more than once, which is one place with two definitions in it,
2988    /// and the machine IR between here and the allocator has one definition per register by
2989    /// construction. An output tied to an input and written once is not that: it is two registers
2990    /// the description ties together, which is what [`Place`] is about.
2991    ///
2992    /// An operand read where the opcode writes, or written where it reads. An output that has not
2993    /// been written yet is not a value, and an input the assembly writes over is a value something
2994    /// else may still be using.
2995    ///
2996    /// # A register the instruction uses without being told
2997    ///
2998    /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
2999    /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
3000    /// registers. The description holds every bit of that already, so what is left is to say which
3001    /// of the statement's operands is in each of those registers, and the constraint letter is the
3002    /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
3003    /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
3004    /// and has no choice about it.
3005    ///
3006    /// A register no letter named is one the statement put nothing in, and that is the usual case
3007    /// rather than an unusual one, since an instruction that answers four questions is written by
3008    /// programs that asked one. A write of one is the register being destroyed and gets a register
3009    /// of its own, which is what tells the allocator to keep everything else out of it. A read of
3010    /// one is a register the instruction looks at and the program never filled, which gets a zero
3011    /// for the reason [`Self::undefined`] gives.
3012    ///
3013    /// # The clobber list
3014    ///
3015    /// Read now, as the registers it names being written by every instruction of the template. By
3016    /// every one rather than by one of them, because the list says the assembly as a whole leaves
3017    /// them ruined and nothing here knows which line did it. Every entry has to be a register this
3018    /// machine has a name for or the statement is refused, since a name nobody read is a register
3019    /// nobody is keeping out of.
3020    ///
3021    /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
3022    /// says the assembly touches storage, which is already true of every `asm` this writes and is
3023    /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
3024    /// tracking already has that from the instructions the template was read into, since it takes
3025    /// every instruction it does not recognize as writing them and every instruction here is one
3026    /// this machine describes.
3027    ///
3028    /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
3029    /// by description, and a statement listing three of them as clobbers as well is saying the
3030    /// same thing twice, which the allocator would read as one register with two definitions.
3031    ///
3032    /// On a template with nothing in it the list is ignored, as it was before, since a template
3033    /// with no instructions ruins nothing whatever it said about what it ruins.
3034    fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
3035        let data = &self.source[inst];
3036        let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
3037        let info = self.source[asm];
3038        if !self.source[info.targets].is_empty() {
3039            return Err(Unsupported::Assembly { inst, refused: Written::Goto });
3040        }
3041        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3042
3043        let constraints = self.names.resolve(info.constraints).to_string();
3044        let results: Vec<Value> = data.results().collect();
3045        let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
3046            .ok_or_else(refused)?;
3047        let list: Vec<AsmOperand> = operands.iter().copied().collect();
3048
3049        // Read after the constraints and not before them, because a mnemonic whose suffix the
3050        // program left off is read at the width of the operands it names, and the operands are
3051        // what the constraints are a list of.
3052        let widths: Vec<Option<x86_64::Width>> = list
3053            .iter()
3054            .map(|operand| {
3055                let ty = self.source[operand.result.or(operand.value)?].ty;
3056                if !ty.is_scalar() {
3057                    return None;
3058                }
3059                x86_64::Width::of_bits(if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() })
3060            })
3061            .collect();
3062        let template = self.names.resolve(info.template).to_string();
3063        let steps = if template.trim().is_empty() {
3064            Vec::new()
3065        } else {
3066            x86_64::read(&template, &widths)
3067                .ok_or(Unsupported::Assembly { inst, refused: Written::Template })?
3068        };
3069
3070        // Which operands the template writes, counted before anything is placed, because the answer
3071        // decides where each of the three below comes from and one instruction may name an operand
3072        // that a later one writes. Which of them any instruction puts in a register at all is
3073        // counted in the same walk, since an operand no instruction reaches that way is one nothing
3074        // has to put anywhere: a constant a template names only as the distance into an address is
3075        // written into the instruction, and a register holding a copy of it would be one nobody
3076        // reads. An operand the address is counted from is reached that way and is counted here for
3077        // that reason, because the walk below it is over the opcode's operands and an address is
3078        // not one of those.
3079        let mut writes = vec![0usize; list.len()];
3080        let mut reads = vec![false; list.len()];
3081        let mut held = vec![false; list.len()];
3082        for step in &steps {
3083            let x86_64::Step::Line(line) = step else { continue };
3084            match line.at.and_then(|at| at.base) {
3085                Some(x86_64::Piece::Operand { index, .. }) => {
3086                    *held.get_mut(index).ok_or_else(refused)? = true;
3087                }
3088                Some(x86_64::Piece::Reg { reg, .. }) => {
3089                    if let Some(index) = bound(&list, reg, Role::Use) {
3090                        *held.get_mut(index).ok_or_else(refused)? = true;
3091                    }
3092                }
3093                _ => {}
3094            }
3095            let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3096            // Which registers the instruction reaches, asked the same way it is asked again when
3097            // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
3098            // comes from the constraint letters rather than from the description.
3099            let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
3100            let (described, pieces) = match &lettered {
3101                Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3102                None => (form.operands(), line.operands.as_slice()),
3103            };
3104            for (desc, piece) in described.iter().zip(pieces) {
3105                // An operand the instruction reaches without its text saying so is the statement's
3106                // only when a constraint letter put something there. One that is nobody's writes
3107                // nothing of the program's, so it is counted nowhere and is dealt with where it is
3108                // placed.
3109                let index = match *piece {
3110                    x86_64::Piece::Operand { index, .. } => index,
3111                    x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
3112                        Some(index) => index,
3113                        None => continue,
3114                    },
3115                    x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
3116                        Some(index) => index,
3117                        None => continue,
3118                    },
3119                };
3120                *held.get_mut(index).ok_or_else(refused)? = true;
3121                if matches!(desc.role, Role::Def | Role::EarlyDef) {
3122                    *writes.get_mut(index).ok_or_else(refused)? += 1;
3123                } else {
3124                    *reads.get_mut(index).ok_or_else(refused)? = true;
3125                }
3126            }
3127        }
3128
3129        // Where every operand is. Worked out in full before the first instruction is written, since
3130        // reading a value may be what puts it in a register in the first place, and that has to
3131        // happen in front of the assembly rather than in the middle of it.
3132        let mut places: Vec<Place> = vec![Place::default(); list.len()];
3133        for (index, operand) in list.iter().copied().enumerate() {
3134            let Some(result) = operand.result else {
3135                // An input, or an output the assembly was handed the address of, and both are a
3136                // value that arrives in a register and is read out of it, unless no instruction of
3137                // the template reads it out of one.
3138                let value = operand.value.ok_or_else(refused)?;
3139                if held[index] {
3140                    places[index].read = Some(self.reg_of(value)?);
3141                }
3142                continue;
3143            };
3144            let ty = self.source[result].ty;
3145            if on_x87(ty) || writes[index] > 1 {
3146                return Err(refused());
3147            }
3148            let tied = operands.tied_to(index);
3149            if let Some(from) = tied {
3150                if self.class_of(self.source[from].ty) != self.class_of(ty) {
3151                    return Err(refused());
3152                }
3153                places[index].read = Some(self.reg_of(from)?);
3154            }
3155            if writes[index] == 1 {
3156                places[index].write = Some(self.new_reg(result));
3157                continue;
3158            }
3159            match tied {
3160                // The place the input arrived in, which the assembly wrote nothing over. One
3161                // register, so this is a rename rather than a move.
3162                Some(_) => {
3163                    let reg = places[index].read.ok_or_else(refused)?;
3164                    self.regs[result.index()] = Some(reg);
3165                    places[index].write = Some(reg);
3166                }
3167                None => {
3168                    self.undefined(inst, result)?;
3169                    places[index].write = self.regs[result.index()];
3170                }
3171            }
3172        }
3173
3174        // An output an instruction of the template also reads, which the statement said nothing
3175        // about because an output is what a statement says the other thing about. What it holds
3176        // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
3177        // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
3178        // than for the number, so whatever the register held, the answer is the same. Undefined is
3179        // not the same as absent though, since the allocator is owed a definition in front of every
3180        // use, so it gets the zero an output nothing wrote gets and for the same reason.
3181        for index in 0..list.len() {
3182            if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
3183                continue;
3184            }
3185            places[index].read = Some(self.seeded(inst, list[index])?);
3186        }
3187
3188        // Worked out once for the whole template, since the list is one list and every instruction
3189        // of the template gets it. Not worked out at all for a template with no instructions, which
3190        // is where there is nothing for it to go on.
3191        let clobbers = self.names.resolve(info.clobbers).to_string();
3192        let clobbered =
3193            if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
3194
3195        // A template with a label in it is not one run of instructions, and what it is instead is
3196        // in [`Self::woven`]. Every other template is what it has always been, which is every
3197        // instruction of it written into the block the statement stands in.
3198        if steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_))) {
3199            return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
3200        }
3201        for step in &steps {
3202            let x86_64::Step::Line(line) = step else { continue };
3203            self.instruction(inst, line, &places, &list, &clobbered)?;
3204        }
3205        Ok(())
3206    }
3207
3208    /// A register holding a zero, for an operand of a template that is read before anything filled
3209    /// it.
3210    ///
3211    /// Two things ask for this and they are the same thing twice. An output the template reads has
3212    /// nothing to be read out of until the instruction that writes it has run, and a loop carries
3213    /// an operand into a block before the instruction that fills it, so both are a use in front of
3214    /// every definition. What the program is owed there is nothing, since the value is undefined
3215    /// either way, and what the allocator is owed is a register something wrote.
3216    fn seeded(&mut self, inst: Inst, operand: AsmOperand) -> Result<mir::Reg, Unsupported> {
3217        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3218        let value = operand.result.or(operand.value).ok_or_else(refused)?;
3219        let class = self.class_of(self.source[value].ty);
3220        if class != self.gpr {
3221            return Err(refused());
3222        }
3223        let block = self.at.expect("a block is being filled");
3224        let reg = self.out.new_vreg(class);
3225        let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_64")));
3226        self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
3227        Ok(reg)
3228    }
3229
3230    /// A template with labels in it, as the blocks its jumps leave and arrive at.
3231    ///
3232    /// A statement is an instruction of the IR and stands inside one block, so a template that
3233    /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
3234    /// stands in and gives it two arms, and whatever follows the statement goes into whichever
3235    /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
3236    /// what [`Self::saves_place`] already does for the same reason.
3237    ///
3238    /// # What is carried between them
3239    ///
3240    /// The machine IR here is in the form where a register is written once, so an operand written
3241    /// inside a loop and read again at the top of it cannot be one register. What arrives at the
3242    /// top is a parameter of that block, and every jump to it carries whichever register held the
3243    /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
3244    /// made takes one parameter for each operand that is in a register at all, in one order, so an
3245    /// arm's arguments and a block's parameters are the same list read twice.
3246    ///
3247    /// Which register an operand is in at each point is kept in the read half of its place, since
3248    /// that is what the instructions below read it out of. An instruction that writes an operand
3249    /// leaves it in the register it wrote, and a jump below carries that one. The block an
3250    /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
3251    /// about where the operands are changes there.
3252    ///
3253    /// An operand written by the template and filled by nothing is written as a zero first, for
3254    /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
3255    /// instruction that fills it has run, and an argument has to be a register something wrote.
3256    ///
3257    /// # The condition state
3258    ///
3259    /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
3260    /// it are both written here, next to each other in one block, and what the allocator may put
3261    /// between them is a move, which on this machine leaves the condition state alone. The edge
3262    /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
3263    /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
3264    fn woven(
3265        &mut self,
3266        inst: Inst,
3267        steps: &[x86_64::Step],
3268        places: &mut [Place],
3269        list: &[AsmOperand],
3270        clobbered: &[PhysReg],
3271        writes: &[usize],
3272    ) -> Result<(), Unsupported> {
3273        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3274        let span = self.source.span(inst);
3275
3276        // Which operands are carried, which is every one that is in a register at all. An operand
3277        // the template never puts in one, such as a constant it names only as the distance into an
3278        // address, is in the instruction and has nowhere to be carried from.
3279        let mut carried: Vec<(usize, RegClass)> = Vec::new();
3280        for (index, operand) in list.iter().enumerate() {
3281            if places[index].read.is_none() && places[index].write.is_none() {
3282                continue;
3283            }
3284            let value = operand.result.or(operand.value).ok_or_else(refused)?;
3285            let ty = self.source[value].ty;
3286            if on_x87(ty) {
3287                return Err(refused());
3288            }
3289            carried.push((index, self.class_of(ty)));
3290        }
3291
3292        // What each of them holds where the template starts.
3293        for &(index, _) in &carried {
3294            if places[index].read.is_some() {
3295                continue;
3296            }
3297            if writes[index] == 0 {
3298                places[index].read = places[index].write;
3299                continue;
3300            }
3301            places[index].read = Some(self.seeded(inst, list[index])?);
3302        }
3303
3304        // The blocks, made before the walk because a jump forwards names a label the walk has not
3305        // reached yet.
3306        let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
3307        for step in steps {
3308            let x86_64::Step::Label(name) = step else { continue };
3309            let block = self.out.create_block();
3310            let mut params = Vec::with_capacity(carried.len());
3311            for &(_, class) in &carried {
3312                params.push(self.out.append_param(block, class));
3313            }
3314            labels.push((name.as_str(), block, params));
3315        }
3316
3317        for step in steps {
3318            match step {
3319                x86_64::Step::Label(name) => {
3320                    let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
3321                    let from = self.at.expect("a block is being filled");
3322                    let args = Self::held(places, &carried).ok_or_else(refused)?;
3323                    *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
3324                    self.at = Some(block);
3325                    for (at, &(index, _)) in carried.iter().enumerate() {
3326                        places[index].read = params.get(at).copied();
3327                    }
3328                }
3329                x86_64::Step::Jump { opcode, to } => {
3330                    let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
3331                    let from = self.at.expect("a block is being filled");
3332                    let args = Self::held(places, &carried).ok_or_else(refused)?;
3333                    let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{opcode}")));
3334                    self.out.build(from, opcode).at(span).finish();
3335                    let next = self.out.create_block();
3336                    *self.out.succs_mut(from) =
3337                        vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
3338                    self.at = Some(next);
3339                }
3340                x86_64::Step::Away { symbol } => {
3341                    // Only in a function that is written without a prologue, which is the one
3342                    // place the jump means what it says. Anywhere else there is an epilogue behind
3343                    // the statement that puts the registers back and gives the frame up, and a
3344                    // jump over it goes to the next function with this function's frame still
3345                    // taken. The reader already made sure it is the last step of the template, so
3346                    // what is left to ask is about the function around it.
3347                    if !self.source.attrs.set.contains(AttrSet::NAKED) {
3348                        return Err(Unsupported::Assembly { inst, refused: Written::Away });
3349                    }
3350                    let from = self.at.expect("a block is being filled");
3351                    let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{AWAY}")));
3352                    let symbol = self.names.intern(symbol);
3353                    self.out.build(from, opcode).at(span).symbol(symbol).finish();
3354                    // Nowhere, which is what a jump out of the function leaves behind it and is
3355                    // the same list a `ret` leaves. The block after it is made for the walk above
3356                    // rather than for the program: the statement may be in the middle of a body
3357                    // that goes on being lowered, and what that lowering writes is reached by
3358                    // nothing and thrown away with the block.
3359                    *self.out.succs_mut(from) = Vec::new();
3360                    self.at = Some(self.out.create_block());
3361                }
3362                x86_64::Step::Line(line) => {
3363                    self.instruction(inst, line, places, list, clobbered)?;
3364                    let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3365                    for (desc, piece) in form.operands().iter().zip(&line.operands) {
3366                        if !desc.role.is_def() {
3367                            continue;
3368                        }
3369                        let index = match *piece {
3370                            x86_64::Piece::Operand { index, .. } => index,
3371                            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
3372                                Some(index) => index,
3373                                None => continue,
3374                            },
3375                            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
3376                                Some(index) => index,
3377                                None => continue,
3378                            },
3379                        };
3380                        let place = places.get_mut(index).ok_or_else(refused)?;
3381                        if place.write.is_some() {
3382                            place.read = place.write;
3383                        }
3384                    }
3385                }
3386            }
3387        }
3388
3389        // Where the walk left each output, which is the parameter of the block a label made when
3390        // the template ends in one and the register an instruction wrote when it does not.
3391        for (index, operand) in list.iter().enumerate() {
3392            let Some(result) = operand.result else { continue };
3393            if let Some(reg) = places[index].read {
3394                self.regs[result.index()] = Some(reg);
3395            }
3396        }
3397        Ok(())
3398    }
3399
3400    /// The block one of the template's labels made, and the parameters it takes.
3401    fn went<'b>(
3402        labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
3403        name: &str,
3404    ) -> Option<(mir::Block, &'b [mir::Reg])> {
3405        labels
3406            .iter()
3407            .find(|(had, ..)| *had == name)
3408            .map(|(_, block, params)| (*block, params.as_slice()))
3409    }
3410
3411    /// The register each carried operand is in, which is what an arm to a label carries.
3412    fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
3413        carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
3414    }
3415
3416    /// The registers a clobber list names, in the order it named them.
3417    ///
3418    /// Nothing is dropped. A name this has no register for is refused, because the list is the
3419    /// program telling the compiler which registers it may not leave anything in, and an entry
3420    /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
3421    /// two entries that are not registers and for why they are skipped rather than refused.
3422    fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
3423        let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
3424        let mut named = Vec::new();
3425        for entry in clobbers.split(',') {
3426            let entry = entry.trim().trim_matches('"');
3427            // The sigil is optional in a clobber list and means nothing when it is there, unlike
3428            // in a template, where it is what tells a register from an operand.
3429            let entry = entry.strip_prefix('%').unwrap_or(entry);
3430            if entry.is_empty() || entry == "memory" || entry == "cc" {
3431                continue;
3432            }
3433            let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
3434            if !named.contains(&reg) {
3435                named.push(reg);
3436            }
3437        }
3438        Ok(named)
3439    }
3440
3441    /// One instruction of a template, as the machine instruction it was read back into.
3442    fn instruction(
3443        &mut self,
3444        inst: Inst,
3445        line: &x86_64::Line,
3446        places: &[Place],
3447        list: &[AsmOperand],
3448        clobbered: &[PhysReg],
3449    ) -> Result<(), Unsupported> {
3450        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3451        let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3452        // What the instruction reaches and what is in each of them. The description answers the
3453        // first for every opcode but one, and the pieces the template was read into answer the
3454        // second. Bytes a program wrote out itself are the one, since nothing in a number is a
3455        // register anybody could read, so the constraint letters answer both. See
3456        // [`Self::lettered`].
3457        let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
3458        let (described, pieces) = match &lettered {
3459            Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3460            None => (form.operands(), line.operands.as_slice()),
3461        };
3462        let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
3463        for (desc, piece) in described.iter().zip(pieces) {
3464            built.push(self.placed(inst, *desc, *piece, places, list)?);
3465        }
3466        // The clobbers go in among the definitions rather than behind the reads, because an operand
3467        // vector in the machine IR is every definition and then every use and what counts them
3468        // reads that order rather than each operand's role.
3469        let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
3470        let mut added = 0usize;
3471        for &reg in clobbered {
3472            if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
3473                continue;
3474            }
3475            built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
3476            added += 1;
3477        }
3478        // A constraint tying one operand to another names it by its place in this vector, and the
3479        // clobbers were put in the middle of the vector, so everything behind them moved. The
3480        // description is written against an instruction with no clobbers in it and cannot know
3481        // that, which makes this the one place the two numberings have to be reconciled.
3482        for operand in &mut built {
3483            if let Constraint::Reuse(at) = operand.constraint {
3484                if usize::from(at) >= defs {
3485                    let moved = usize::from(at) + added;
3486                    operand.constraint =
3487                        Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
3488                }
3489            }
3490        }
3491        let at = match line.at {
3492            Some(at) => Some(self.addressed(inst, at, places, list)?),
3493            None => None,
3494        };
3495
3496        let block = self.at.expect("a block is being filled");
3497        let span = self.source.span(inst);
3498        let opcode = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", line.opcode)));
3499        let mut build = self.out.build(block, opcode).at(span);
3500        for operand in built {
3501            build = build.operand(operand);
3502        }
3503        if let Some(value) = line.imm {
3504            build = build.imm(value);
3505        }
3506        if let Some(mem) = at {
3507            build = build.mem(mem);
3508        }
3509        build.finish();
3510        Ok(())
3511    }
3512
3513    /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
3514    /// description of an opcode.
3515    ///
3516    /// Every other instruction of a template has a description saying which registers it reaches
3517    /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
3518    /// wrote out itself have no such description and could not have one: what the instruction is, is
3519    /// a number, and nothing in a number is a register anything could read. So the letters are the
3520    /// whole of what is known, and they are enough, because a program writing an instruction this
3521    /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
3522    ///
3523    /// Each register named by a letter gets one entry for the write and one for the read, the same
3524    /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
3525    /// written here and one no input names is not read. The writes come first because that is the
3526    /// order an operand vector in the machine IR is counted in. A register named by nothing is left
3527    /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
3528    /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
3529    /// touch is known only from what the program said.
3530    fn lettered(&self, list: &[AsmOperand]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
3531        let mut named: Vec<PhysReg> = Vec::new();
3532        for operand in list {
3533            if let Some(reg) = operand.fixed.and_then(x86_64::gpr_letter) {
3534                if !named.contains(&reg) {
3535                    named.push(reg);
3536                }
3537            }
3538        }
3539        let mut described = Vec::with_capacity(named.len() * 2);
3540        let mut pieces = Vec::with_capacity(named.len() * 2);
3541        for role in [Role::Def, Role::Use] {
3542            for &reg in &named {
3543                if bound(list, reg, role).is_none() {
3544                    continue;
3545                }
3546                let desc = if role.is_def() {
3547                    OperandDesc::write(self.gpr)
3548                } else {
3549                    OperandDesc::read(self.gpr)
3550                };
3551                described.push(desc.with(Constraint::Fixed(reg)));
3552                pieces.push(x86_64::Piece::Implicit { reg });
3553            }
3554        }
3555        (described, pieces)
3556    }
3557
3558    /// One operand of one instruction of a template, in the register the statement put it in.
3559    fn placed(
3560        &mut self,
3561        inst: Inst,
3562        desc: OperandDesc,
3563        piece: x86_64::Piece,
3564        places: &[Place],
3565        list: &[AsmOperand],
3566    ) -> Result<mir::Operand, Unsupported> {
3567        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3568        // A register the instruction reaches without its text naming it belongs to whichever of the
3569        // statement's operands a constraint letter put there, and to nobody when no letter did.
3570        // There is no width to check in that case: the operand is the register the letter named and
3571        // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
3572        let (index, spelled) = match piece {
3573            x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
3574            x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
3575                Some(index) => (index, None),
3576                None => return self.spare(inst, desc),
3577            },
3578            // A register the template named, which belongs to one of the statement's operands when
3579            // a constraint letter put that operand there and to nobody otherwise. Asked in that
3580            // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
3581            // the program saying one thing twice, and answering it twice would hand the allocator
3582            // one register holding two values.
3583            x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
3584                Some(index) => (index, None),
3585                None => return self.itself(inst, desc, reg),
3586            },
3587        };
3588        let operand = list.get(index).copied().ok_or_else(refused)?;
3589        // The two halves of an operand written `+`, which arrives in one register and leaves in
3590        // another with the allocator told to make them the same one. Everything else has one of
3591        // the two and asking for the other is the refusal below.
3592        let place = places.get(index).copied().ok_or_else(refused)?;
3593        let reg = match desc.role {
3594            Role::Use => place.read,
3595            Role::Def | Role::EarlyDef => place.write,
3596        }
3597        .ok_or_else(refused)?;
3598
3599        // Read where the opcode reads and written where it writes, which is what the first half of
3600        // this asks. An output has a result and an input has a value, an output written `+` has
3601        // both because it is read before it is written, and an output a matching constraint names
3602        // is read as the input that named it. See [`read_as`].
3603        // An output with neither is read as well, and what it holds there is undefined, which
3604        // [`Self::assembly`] says why and puts a zero in a register for.
3605        let placeable = match desc.role {
3606            Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
3607            Role::Def | Role::EarlyDef => operand.result.is_some(),
3608        };
3609        let ty = match (operand.result, operand.value) {
3610            (Some(result), _) => self.source[result].ty,
3611            (None, Some(value)) => self.source[value].ty,
3612            (None, None) => return Err(refused()),
3613        };
3614        let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3615        if !placeable || self.class_of(ty) != desc.class {
3616            return Err(refused());
3617        }
3618        if let Some((width, stated)) = spelled {
3619            // An operand the template wrote a width on may be written by an instruction that fills
3620            // more of the register than the object in it does, and the object is then the low part
3621            // of what was written. That is what gmp asks for when it counts the low zero bits of a
3622            // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
3623            // the whole register and the `unsigned` is the bottom of it, which is every bit of an
3624            // answer that cannot exceed sixty four anyway.
3625            //
3626            // Only written, and only wider. A read of more of a register than its type fills is a
3627            // program handing an instruction bits nothing ever put there. A write of less of one
3628            // leaves the top of the object holding whatever the register held before, which is the
3629            // same thing one instruction later. Both are refused, and an operand the template left
3630            // plain is refused either way, because what gets spelled for that one is the register
3631            // at the width of its type and no other instruction is the one written down.
3632            let widened = stated && desc.role.is_def() && width.bits() > bits;
3633            if bits != width.bits() && !widened {
3634                return Err(refused());
3635            }
3636        }
3637        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
3638    }
3639
3640    /// A register the template named in its own text.
3641    ///
3642    /// Not one of the statement's operands and not something the allocator handed out. The program
3643    /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
3644    /// something the constraint letters cannot say is made of: micropython saves the callee-saved
3645    /// registers into a buffer by name because the whole point of the buffer is that those exact
3646    /// registers are in it, and there is no constraint letter for `%rsp`.
3647    ///
3648    /// So it is placed as itself, fixed to the register the template named. What that buys is the
3649    /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
3650    /// write of one is a definition it knows about and will not leave anything of the program's
3651    /// across, and a read of one is a use it will not have put something else in first. gcc copies
3652    /// the text out and a register two things believe they own is a wrong program nothing reports.
3653    /// Here the allocator is told, and a program that also named the register in its clobber list
3654    /// says the same thing twice rather than something new.
3655    fn itself(
3656        &mut self,
3657        inst: Inst,
3658        desc: OperandDesc,
3659        reg: PhysReg,
3660    ) -> Result<mir::Operand, Unsupported> {
3661        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
3662        if desc.class != self.gpr {
3663            return Err(refused);
3664        }
3665        Ok(mir::Operand {
3666            reg: mir::Reg::physical(reg),
3667            class: self.gpr,
3668            role: desc.role,
3669            constraint: Constraint::Fixed(reg),
3670        })
3671    }
3672
3673    /// A register an instruction of a template uses and the statement put nothing in.
3674    ///
3675    /// A write of one is the register being destroyed, which is what a clobber list is usually
3676    /// written to say and what an instruction with more answers than the program asked for does
3677    /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
3678    /// register of its own is the whole of what that needs, since a value nothing reads is one the
3679    /// allocator may put anywhere and is told about so that nothing else is put there.
3680    ///
3681    /// A read of one is a register the instruction looks at and the program never filled, which
3682    /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
3683    /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
3684    /// zero is the one answer that reads the same on every run.
3685    fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
3686        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
3687        if desc.class != self.gpr {
3688            return Err(refused);
3689        }
3690        let reg = self.out.new_vreg(desc.class);
3691        if !desc.role.is_def() {
3692            let block = self.at.expect("a block is being filled");
3693            let span = self.source.span(inst);
3694            let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_64")));
3695            self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
3696        }
3697        Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
3698    }
3699
3700    /// The address one instruction of a template reads or writes.
3701    fn addressed(
3702        &mut self,
3703        inst: Inst,
3704        at: x86_64::At,
3705        places: &[Place],
3706        list: &[AsmOperand],
3707    ) -> Result<mir::Mem, Unsupported> {
3708        let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3709        let base = match at.base {
3710            None => None,
3711            Some(x86_64::Piece::Operand { index, .. }) => {
3712                // The register an address is counted from is read and never written, whatever the
3713                // instruction does to what it finds there.
3714                let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
3715                Some(mir::Operand::read(reg, self.gpr))
3716            }
3717            // A register the template named, counted from as itself. See [`Self::itself`], and note
3718            // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
3719            // names one register as the thing being stored and another as where to store it. An
3720            // operand a constraint letter put in that register is that operand, for the reason
3721            // [`Self::placed`] gives.
3722            Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
3723                Some(index) => {
3724                    let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
3725                    Some(mir::Operand::read(reg, self.gpr))
3726                }
3727                None => Some(
3728                    mir::Operand::read(mir::Reg::physical(reg), self.gpr)
3729                        .with(Constraint::Fixed(reg)),
3730                ),
3731            },
3732            // An address counted from a register the instruction reaches without being told is
3733            // not something this machine has: every addressing mode is written out in the text it
3734            // is part of, so a base that got here another way is a base nothing wrote down.
3735            Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
3736        };
3737        // A distance the template wrote, or the one in an operand the template pointed at, which is
3738        // the same distance said by something that knows how big a thing is. It has to be a number
3739        // the compiler can read at translation time, since it goes in the instruction rather than
3740        // in a register, and an operand holding anything else is refused rather than put somewhere.
3741        let disp = match at.disp {
3742            x86_64::Disp::Number(disp) => disp,
3743            x86_64::Disp::Operand(index) => {
3744                let value =
3745                    list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
3746                let number = self.number(value).ok_or_else(refused)?;
3747                i32::try_from(number).map_err(|_| refused())?
3748            }
3749        };
3750        Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
3751    }
3752
3753    /// The number in that value, for one an `iconst` defined, read at the width of its own type.
3754    ///
3755    /// Signed, because the two things a template asks this for are a distance into an address and
3756    /// the number on an instruction, and both of those are signed wherever they land. A constant
3757    /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
3758    /// which is the same number and is the reading that fits in the thirty two bits an addressing
3759    /// mode has room for.
3760    fn number(&self, value: Value) -> Option<i128> {
3761        let Def::Result { inst, .. } = self.source[value].def else { return None };
3762        if self.source[inst].opcode != Opcode::IConst {
3763            return None;
3764        }
3765        let Extra::Imm(imm) = self.source[inst].extra else { return None };
3766        let bits = self.source[imm].bits();
3767        let width = self.source[value].ty.bits();
3768        if width == 0 || width > 128 {
3769            return None;
3770        }
3771        let spare = 128 - width;
3772        Some(((bits << spare) as i128) >> spare)
3773    }
3774
3775    /// A register holding a value the program has no claim on, written as a zero.
3776    ///
3777    /// Every other way of saying it costs the same instruction or needs a word the machine IR does
3778    /// not have, and a zero is the one that reads the same on every run.
3779    fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
3780        let ty = self.source[result].ty;
3781        let refused = Unsupported::Assembly { inst, refused: Written::Operand };
3782        if self.class_of(ty) != self.gpr || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3783            return Err(refused);
3784        }
3785        let block = self.at.expect("a block is being filled");
3786        let span = self.source.span(inst);
3787        let reg = self.new_reg(result);
3788        let put = mir::Opcode::new(self.names.intern(&format!("{PREFIX}mov_ri_{}", ty.bits())));
3789        self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
3790        Ok(())
3791    }
3792
3793    /// Whether a type is the width an address is, which is what makes a cast to or from one free.
3794    fn is_address_width(&self, ty: Type) -> bool {
3795        ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
3796    }
3797
3798    /// Where a block goes, which in machine IR is on the block rather than on its terminator.
3799    ///
3800    /// That is why no rule ever names a block: a branch is selected for what it reads and the
3801    /// edges are copied across here, arguments and all. The arguments are read last, after every
3802    /// instruction of the block is written, because an argument that is a constant is
3803    /// materialized where it is first wanted and the end of the block is where an edge wants it.
3804    ///
3805    /// Which is not quite the end. A block that leaves two ways has the branch as its last
3806    /// instruction, and a block that leaves through a register has the indirect jump as its last,
3807    /// and anything appended after either is something it has already jumped past, so a constant
3808    /// materialized here would be a register the block below reads and nothing ever writes. The
3809    /// one that was there is put back on the end when that happened, which is the only reordering
3810    /// anything in this crate does and is why it is remembered before a single argument is read.
3811    fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
3812        let Some(term) = self.source.terminator(block) else { return Ok(()) };
3813        let leaves = matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr);
3814        let branch = if leaves { self.out.terminator(out) } else { None };
3815
3816        let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
3817        let mut succs = Vec::with_capacity(calls.len());
3818        for call in calls {
3819            let args: Vec<Value> = self.source[call.args].to_vec();
3820            let mut regs = Vec::with_capacity(args.len());
3821            for value in args {
3822                // The address of where the value is rather than the value, for the one type a
3823                // register holds none of. The block on the other side copies the bytes out of it
3824                // into a slot of its own, which is what makes a second edge into the same block
3825                // safe.
3826                let reg = if on_x87(self.source[value].ty) {
3827                    self.x87_slot(value)
3828                } else {
3829                    self.reg_of(value)?
3830                };
3831                regs.push(reg);
3832            }
3833            succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
3834        }
3835        if let Some(branch) = branch {
3836            if self.out.terminator(out) != Some(branch) {
3837                self.out.remove_inst(branch);
3838                self.out.append_inst(out, branch);
3839            }
3840        }
3841        *self.out.succs_mut(out) = succs;
3842        Ok(())
3843    }
3844
3845    /// The machine IR block an IR block became.
3846    fn out_block(&self, block: Block) -> mir::Block {
3847        self.blocks[block.index()].expect("every block was created before any was filled")
3848    }
3849
3850    /// The parameters of the entry block, which are the function's arguments.
3851    ///
3852    /// They are not block parameters in the machine IR and they cannot be. A block parameter is
3853    /// given its value by a move on the edge into the block, and there is no edge into an entry
3854    /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
3855    /// says it.
3856    ///
3857    /// The ones past the last register arrived in the caller's memory and are read out of it, and
3858    /// the loads that read them come back here so that the frame can finish them the way it
3859    /// finishes an `alloca`.
3860    fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
3861        let params = self.source[block].params.clone();
3862        // The type of each is the block's answer and what the ABI asks of it is the signature's,
3863        // and the two lists are the same list: a parameter the classification turned into a
3864        // pointer is a pointer in the block too. A block with more parameters than the signature
3865        // names is not one the front end writes, and each of those is taken as a plain value.
3866        let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
3867        let types: Vec<Param> = params
3868            .iter()
3869            .enumerate()
3870            .map(|(index, &value)| {
3871                let abi = asked.get(index).copied().unwrap_or_default();
3872                Param { ty: self.source[value].ty, abi }
3873            })
3874            .collect();
3875        // A save area for a function that takes arguments its signature does not name, which is a
3876        // block of this function's frame on one convention and the shadow space the caller already
3877        // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
3878        // [`Self::save_area`] is where the difference is spent.
3879        let variadic = self.source.signature().variadic;
3880        let area = variadic.then(|| varargs::Area::of(self.conv));
3881        let arrived = abi::entry(&mut self.out, out, &types, self.conv, self.names, area)
3882            .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
3883        for (&param, reg) in params.iter().zip(&arrived.regs) {
3884            self.regs[param.index()] = Some(*reg);
3885        }
3886        if let Some(area) = area {
3887            self.save_area(out, &arrived, area);
3888        }
3889        self.stack.arguments.extend(arrived.stack);
3890        Ok(())
3891    }
3892
3893    /// The prologue of a variadic function, which is every argument register it was handed written
3894    /// into the frame.
3895    ///
3896    /// Every one the signature did not name, that is. Which of those hold anything is a thing only
3897    /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
3898    /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
3899    /// ever reads their slots.
3900    ///
3901    /// What that costs is up to fourteen stores in the prologue of a function that may read none of
3902    /// them, and the convention's answer to that is the count of vector registers in `%al`, which
3903    /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
3904    /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
3905    /// has no blocks to branch between. So they are all written every time, which is correct and is
3906    /// what `-O0` costs. Issue #323 is the branch.
3907    ///
3908    /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
3909    /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
3910    /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
3911    ///
3912    /// The address is computed once into a register rather than written as a displacement off the
3913    /// stack pointer, because a displacement into a frame is not known until after allocation and
3914    /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
3915    /// gets and [`crate::finish`] fills it in the same way.
3916    ///
3917    /// A convention that homes its register arguments has none of that. Its area is the shadow
3918    /// space the caller reserved above the return address, so there is no object to make and no
3919    /// address to work out: each store reaches into the caller's argument area the way the load of
3920    /// a parameter the registers ran out before does, which is the same waiting list and the same
3921    /// fixup. There are at most four of them and none is a vector register, since a float the
3922    /// signature does not name arrived in a general purpose register too and that is the copy the
3923    /// walk reads.
3924    fn save_area(&mut self, out: mir::Block, arrived: &abi::Arrived, area: varargs::Area) {
3925        if self.conv.shared_positions {
3926            self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
3927            let store = mir::Opcode::new(self.names.intern("x64.mov_mr_64"));
3928            for &(reg, class, at) in &arrived.spare {
3929                let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
3930                let made =
3931                    self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
3932                self.stack.arguments.push((made, at));
3933            }
3934            return;
3935        }
3936
3937        let save = self.stack.locals.len();
3938        self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
3939        self.varargs = Some(Varargs::Fields {
3940            save,
3941            incoming: arrived.beyond,
3942            integers: u32::try_from(arrived.took.0).unwrap_or(0) * area.stride(false),
3943            floats: area.starts_at(true)
3944                + u32::try_from(arrived.took.1).unwrap_or(0) * area.stride(true),
3945        });
3946
3947        let base = self.frame_address(out, save);
3948        for &(reg, class, at) in &arrived.spare {
3949            let name = if class == self.gpr { "x64.mov_mr_64" } else { "x64.movaps_mr" };
3950            let store = mir::Opcode::new(self.names.intern(name));
3951            let up = i32::try_from(at).expect("a register save area under two gigabytes");
3952            let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
3953            self.out.build(out, store).uses(reg, class).mem(mem).finish();
3954        }
3955    }
3956
3957    /// The address of one of the function's stack objects, in a fresh register.
3958    ///
3959    /// Written with nothing in its displacement, because where an object is in a frame is not known
3960    /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
3961    fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
3962        let reg = self.out.new_vreg(self.gpr);
3963        let lea = mir::Opcode::new(self.names.intern(&format!("{PREFIX}{}", x86_64::FRAME.lea)));
3964        let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
3965        let made = self.out.build(out, lea).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
3966        self.stack.addresses.push((made, local));
3967        reg
3968    }
3969
3970    /// Whether an instruction is one no machine instruction is written for where it stands.
3971    ///
3972    /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
3973    /// written where a register for it is first wanted rather than where the IR put it, and every
3974    /// reader of one may have folded it into an immediate, in which case nowhere is the right
3975    /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
3976    /// and leaves, and it is appended to every block with no successors long after this has
3977    /// finished, so a return with a value is one instruction here and a return without one is
3978    /// none. Unless the value went back through memory, in which case there is something to put
3979    /// somewhere after all and the IR does not carry it: the address the caller handed over has
3980    /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
3981    ///
3982    /// An unconditional jump is the third, and there is even less of it: the edge is on the
3983    /// block, and whether the block it goes to is the next one and needs no jump at all is the
3984    /// block layout's answer rather than this one's.
3985    ///
3986    /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
3987    /// the `unreachable` terminator the front end puts at the end of a function whose body can run
3988    /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
3989    /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
3990    /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
3991    /// successors, so the epilogue lands at the end of it the way it does on any other block that
3992    /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
3993    /// the assembler puts next.
3994    fn writes_nothing(&self, inst: Inst) -> bool {
3995        let data = &self.source[inst];
3996        match data.opcode {
3997            Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
3998            Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
3999            _ => false,
4000        }
4001    }
4002
4003    /// What every instruction in one block matched, with a set of values nobody may take.
4004    ///
4005    /// Backwards, because an instruction that has been folded into a later one does not get to
4006    /// fold anything into itself: the rule that took it only reached one level down, so what is
4007    /// under it is not in the term the matcher saw and cannot be replaced.
4008    fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
4009        let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
4010        let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
4011        let mut folded: Vec<Inst> = Vec::new();
4012        for (index, &inst) in insts.iter().enumerate().rev() {
4013            if folded.contains(&inst) {
4014                continue;
4015            }
4016            if let Some((plan, matched)) = self.select(inst, refused) {
4017                folded.extend(self.folds(inst, plan));
4018                found[index] = Some(matched);
4019                plans[index] = Some(plan);
4020            }
4021        }
4022        Decided { found, plans, folded }
4023    }
4024
4025    /// A value some of its readers took and some of them did not, which is the one case folding
4026    /// buys nothing.
4027    ///
4028    /// Folding does not delete the instruction that computed a value for anybody else, so a
4029    /// reader that did not take it still needs it in a register and the instruction stays. The
4030    /// reader that did take it now does that work again. Either all of them take it, in which
4031    /// case nothing is left to read it and the instruction goes, or none of them do.
4032    ///
4033    /// The count is over the whole function rather than over the block, since a value read from
4034    /// another block is read from a register there whatever this block decides. An instruction
4035    /// built by name rather than matched, a call being the one that matters, has no plan and so
4036    /// takes nothing, which is the right answer for it as well.
4037    fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
4038        let mut taken = vec![0u32; self.uses.len()];
4039        for (&inst, plan) in insts.iter().zip(plans) {
4040            let Some(plan) = plan else { continue };
4041            let args = &self.source[self.source[inst].args];
4042            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
4043                if plan[index] == Shown::Expand {
4044                    taken[arg.index()] += 1;
4045                }
4046            }
4047        }
4048        for (&inst, plan) in insts.iter().zip(plans) {
4049            let Some(plan) = plan else { continue };
4050            let args = &self.source[self.source[inst].args];
4051            for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
4052                if plan[index] == Shown::Expand && taken[arg.index()] < self.uses[arg.index()] {
4053                    return Some(arg);
4054                }
4055            }
4056        }
4057        None
4058    }
4059
4060    /// The rule that fires on an instruction, and what it bound.
4061    ///
4062    /// The plans are tried in order and the first that matches wins, which is the maximal munch
4063    /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
4064    /// that offers less.
4065    fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
4066        for plan in self.plans(inst, refused) {
4067            let terms = Terms::new(self.source, inst, plan);
4068            if let Some(matched) = TABLE.find(&terms, Term::Root) {
4069                return Some((plan, matched));
4070            }
4071        }
4072        None
4073    }
4074
4075    /// Every way this instruction can be shown to the matcher, most offered first.
4076    fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> Vec<Plan> {
4077        let args = &self.source[self.source[inst].args];
4078        let mut plans = vec![PLAIN];
4079        for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
4080            let mut ways = Vec::new();
4081            if self.foldable(inst, arg, refused) {
4082                ways.push(Shown::Expand);
4083            }
4084            if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
4085                ways.push(Shown::Const);
4086            }
4087            ways.push(Shown::Reg);
4088            plans = plans
4089                .into_iter()
4090                .flat_map(|plan| {
4091                    ways.iter().map(move |&way| {
4092                        let mut next = plan;
4093                        next[index] = way;
4094                        next
4095                    })
4096                })
4097                .collect();
4098        }
4099        plans
4100    }
4101
4102    /// Whether an operand may be shown as the instruction that computed it.
4103    ///
4104    /// It has to be in the same block, because a rule that folds one instruction into another
4105    /// moves the work to where the second one is. It has to be something rather than a block
4106    /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
4107    /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
4108    /// question is asked here: this says yes to a value with any number of readers, and a value
4109    /// only some of them could take is refused after the fact and asked again.
4110    ///
4111    /// A value with several readers used to be refused outright, on the reasoning that folding
4112    /// does not delete the instruction for anybody else. That reasoning is about the set of
4113    /// readers and was being applied to one reader at a time, which is stricter than it needs to
4114    /// be: when every reader takes it there is nobody left to read it and the instruction goes.
4115    /// An address a store and a load share is the shape that matters, since a memory operand has
4116    /// room for the whole of it and both readers have a memory operand.
4117    fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
4118        let Def::Result { inst, .. } = self.source[value].def else { return false };
4119        if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
4120            return false;
4121        }
4122        self.source.block_of(inst).is_some()
4123            && self.source.block_of(inst) == self.source.block_of(into)
4124    }
4125
4126    /// The instructions a match folded into the one it matched.
4127    ///
4128    /// The plan is what says this, not the bindings: a binding is a register or a number either
4129    /// way, and an operand shown as the instruction that computed it is one no rule could have
4130    /// matched without taking that instruction, because the plan offered the matcher nothing
4131    /// else to call it.
4132    fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
4133        let args = &self.source[self.source[inst].args];
4134        args.iter()
4135            .take(MAX_ARGS)
4136            .enumerate()
4137            .filter(|&(index, _)| plan[index] == Shown::Expand)
4138            .filter_map(|(_, &arg)| match self.source[arg].def {
4139                Def::Result { inst, .. } => Some(inst),
4140                Def::Param { .. } => None,
4141            })
4142            .collect()
4143    }
4144
4145    /// What the IR instruction said about itself that the machine instruction has to keep saying.
4146    ///
4147    /// One flag today. `volatile` says the access happens exactly once and is never moved or
4148    /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
4149    /// one are the same instruction over the same address, so a pass that puts two accesses
4150    /// together would put these together too. Carried rather than checked here, because the pass
4151    /// that has to refuse is a long way down and this is the last place the answer is known.
4152    ///
4153    /// The instructions this compiler writes for itself get nothing, which is the right answer
4154    /// for all of them: a prologue, a spill and the moves around a call were asked for by the
4155    /// machine rather than by the program.
4156    ///
4157    /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
4158    /// the two ends of a `long double` copy that are the program's own memory, and the compare
4159    /// and exchange and the read modify write. An `asm` statement does not, and it is the one
4160    /// exception on purpose. What the flag says there is that the statement stays even when
4161    /// nothing reads what it wrote, which is a different sentence about a different thing, and
4162    /// every `asm` is already fixed where it stands whether the word was written or not.
4163    fn carried(&self, inst: Inst) -> mir::Flags {
4164        if self.source[inst].flags.contains(Flags::VOLATILE) {
4165            mir::Flags::VOLATILE
4166        } else {
4167            mir::Flags::NONE
4168        }
4169    }
4170
4171    /// Build the machine instruction a match calls for.
4172    fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
4173        let rule: &Rule = TABLE.rule(matched);
4174        let pieces = rule.replacement;
4175        let Some(Piece::App { head, arity }) = pieces.first() else {
4176            return Err(self.unsupported(inst));
4177        };
4178        let opcode = head.strip_prefix(PREFIX).ok_or_else(|| self.unsupported(inst))?;
4179        let form = x86_64::form(opcode).ok_or_else(|| self.unsupported(inst))?;
4180
4181        let mut read = Read::default();
4182        let mut at = 1;
4183        for _ in 0..*arity {
4184            at = self.read(inst, pieces, at, &matched.bindings, &mut read)?;
4185        }
4186
4187        let descs = form.operands();
4188        let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
4189        if descs.len() - writes != read.regs.len() {
4190            return Err(self.unsupported(inst));
4191        }
4192
4193        // The first thing the instruction writes is what it computes, and any others are
4194        // registers the machine destroys on the way, which are fresh because nothing else is in
4195        // them and nothing reads them. An instruction that writes nothing at all is one whose
4196        // whole purpose is its effect, which is what a store is, and there is no result to put
4197        // anywhere.
4198        let mut regs = Vec::new();
4199        if writes > 0 {
4200            let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
4201            regs.push(self.new_reg(result));
4202            // The rest are the registers the machine destroys on the way, and the class each is in
4203            // is the one the instruction's description gives it rather than a guess, so that an
4204            // instruction that wrecks a register in the other file says so.
4205            regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
4206        } else if self.source[inst].first_result.is_some() {
4207            // A rule that throws away a value the IR gave a name to would leave every reader of
4208            // that name with nothing to read, so it is a rule this and the target disagree about.
4209            return Err(self.unsupported(inst));
4210        }
4211        regs.extend(read.regs.iter().copied());
4212
4213        let block = self.at.expect("a block is being filled");
4214        let opcode = mir::Opcode::new(self.names.intern(head));
4215        let (span, flags) = (self.source.span(inst), self.carried(inst));
4216        let mut build = self.out.build(block, opcode).at(span).flags(flags);
4217        for (desc, reg) in descs.iter().zip(regs) {
4218            let operand = mir::Operand {
4219                reg,
4220                class: desc.class,
4221                role: desc.role,
4222                constraint: desc.constraint,
4223            };
4224            build = build.operand(operand);
4225        }
4226        if let Some(mem) = read.mem {
4227            build = build.mem(mem);
4228        }
4229        if let Some(imm) = read.imm {
4230            build = build.imm(imm);
4231        }
4232        build.finish();
4233        Ok(())
4234    }
4235
4236    /// Read one argument of a replacement, which is a register, a number or an address.
4237    ///
4238    /// Gives back the position after it, because a replacement is flat and an address takes
4239    /// arguments of its own.
4240    fn read(
4241        &mut self,
4242        inst: Inst,
4243        pieces: &'static [Piece],
4244        at: usize,
4245        bindings: &[Term],
4246        out: &mut Read,
4247    ) -> Result<usize, Unsupported> {
4248        match pieces.get(at) {
4249            Some(Piece::Int(value)) => {
4250                out.imm = i64::try_from(*value).ok();
4251                Ok(at + 1)
4252            }
4253            // A number the rule worked out of the ones it matched rather than one it wrote down,
4254            // which is an immediate once it has been worked out and is read here as one. It gives
4255            // nothing back when a binding it reads is a register, and a replacement that cannot be
4256            // built is a rule this file and the matcher disagree about, which is what `unsupported`
4257            // is for.
4258            Some(Piece::Computed { work, .. }) => {
4259                let matched: Vec<Option<i128>> = bindings
4260                    .iter()
4261                    .map(|term| match *term {
4262                        Term::Num(value) => Some(value),
4263                        _ => None,
4264                    })
4265                    .collect();
4266                let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
4267                out.imm = i64::try_from(number).ok();
4268                Ok(at + 1)
4269            }
4270            Some(Piece::Var { index, .. }) => {
4271                match bindings.get(*index) {
4272                    Some(&Term::Reg(value)) => {
4273                        let reg = self.reg_of(value)?;
4274                        out.regs.push(reg);
4275                    }
4276                    Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
4277                    // A pattern binds a register or a number and nothing else, so this is a
4278                    // rule the matcher and this file disagree about.
4279                    _ => return Err(self.unsupported(inst)),
4280                }
4281                Ok(at + 1)
4282            }
4283            Some(Piece::App { head, arity }) => {
4284                let kind = x86_64::address(head).ok_or_else(|| self.unsupported(inst))?;
4285                let mut inner = Read::default();
4286                let mut next = at + 1;
4287                for _ in 0..*arity {
4288                    next = self.read(inst, pieces, next, bindings, &mut inner)?;
4289                }
4290                let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
4291                out.mem = Some(mem);
4292                Ok(next)
4293            }
4294            None => Err(self.unsupported(inst)),
4295        }
4296    }
4297
4298    /// The register a value is in, materializing it if it is a constant that has not been put in
4299    /// one yet.
4300    ///
4301    /// A constant is written where it is wanted rather than where the IR defined it, and where it
4302    /// is wanted is a block that need not be the one the IR defined it in. So the register holding
4303    /// one is only good inside the block it was written into, and a second block that wants the
4304    /// same constant gets its own. Anything else is a register read where nothing wrote it: the
4305    /// IR guarantees a definition dominates its uses, and this moved the definition.
4306    ///
4307    /// Writing the number again is also the right answer and not merely the safe one. It is one
4308    /// instruction that reads nothing, which is cheaper than holding a register live across a
4309    /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
4310    fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
4311        let constant = match self.source[value].def {
4312            Def::Result { inst, .. } => {
4313                (self.source[inst].opcode == Opcode::IConst).then_some(inst)
4314            }
4315            Def::Param { .. } => None,
4316        };
4317        let here = self.at.expect("a block is being filled");
4318        if let Some(reg) = self.regs[value.index()] {
4319            if constant.is_none() || self.written[value.index()] == Some(here) {
4320                return Ok(reg);
4321            }
4322        }
4323        if let Some(inst) = constant {
4324            // Cleared so that the register the constant is written into is a new one rather than
4325            // the one the block above wrote, which is still being read up there.
4326            self.regs[value.index()] = None;
4327            // Nothing is refused here. A constant is written on its own, out of the loop over the
4328            // block, and the operands of the rule that writes one are the number and nothing else.
4329            let matched = self
4330                .select(inst, &HashSet::new())
4331                .map(|(_, matched)| matched)
4332                .ok_or_else(|| self.unsupported(inst))?;
4333            self.emit(inst, &matched)?;
4334            // The same mark the loop over the instructions makes, and it has to be made here as
4335            // well because this is the only place a constant is ever selected: the loop skips one
4336            // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
4337            // would be reported as a rule nothing reaches.
4338            self.fired.mark(matched.rule);
4339            self.written[value.index()] = Some(here);
4340            return Ok(self.regs[value.index()].expect("a constant is written into a register"));
4341        }
4342        Ok(self.new_reg(value))
4343    }
4344
4345    /// Which register file a value of that type lives in.
4346    ///
4347    /// The vector one for the two float widths the machine has scalar instructions for and for the
4348    /// one it only moves, and the general purpose one for everything else. An eighty bit `long
4349    /// double` is in neither, and it is here rather than in the vector class on purpose: it would
4350    /// be put in a register that cannot hold it, and there is no rule that names one, so the
4351    /// instruction computing it is reported. The wrong class would make that a wrong program
4352    /// instead of a refused one.
4353    ///
4354    /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
4355    /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
4356    /// what the class buys is the moves: a register that holds the whole value is a register a
4357    /// spill, a reload and a copy are each one instruction for.
4358    fn class_of(&self, ty: Type) -> RegClass {
4359        if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
4360    }
4361
4362    /// A fresh register for a value, which is what the instruction computing it writes.
4363    fn new_reg(&mut self, value: Value) -> mir::Reg {
4364        if let Some(reg) = self.regs[value.index()] {
4365            return reg;
4366        }
4367        let reg = self.out.new_vreg(self.class_of(self.source[value].ty));
4368        self.regs[value.index()] = Some(reg);
4369        reg
4370    }
4371
4372    fn unsupported(&self, inst: Inst) -> Unsupported {
4373        let data = &self.source[inst];
4374        Unsupported::Inst {
4375            inst,
4376            term: Terms::new(self.source, inst, PLAIN).name(inst),
4377            opcode: data.opcode,
4378            ty: data.first_result.map(|result| self.source[result].ty),
4379        }
4380    }
4381}
4382
4383/// What the arguments of one replacement came to.
4384#[derive(Debug, Default)]
4385struct Read {
4386    regs: Vec<mir::Reg>,
4387    imm: Option<i64>,
4388    mem: Option<mir::Mem>,
4389}
4390
4391/// The addressing mode an address constructor's arguments make.
4392///
4393/// One arm per constructor rather than a question asked of the kind, because what the arguments
4394/// mean is the whole of what tells the four apart: the same register is a base in one and an
4395/// index in another, and the same constant is a scale in one and a displacement in another.
4396fn address(kind: x86_64::Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
4397    let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
4398    match kind {
4399        x86_64::Address::BaseIndexScale => {
4400            let base = regs.next()?;
4401            let index = regs.next()?;
4402            Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
4403        }
4404        x86_64::Address::IndexScale => Some(mir::Mem {
4405            base: None,
4406            index: Some(regs.next()?),
4407            scale: u8::try_from(read.imm?).ok()?,
4408            disp: 0,
4409            symbol: None,
4410            block: None,
4411            reach: mir::Reach::Itself,
4412            segment: None,
4413        }),
4414        x86_64::Address::Base => Some(mir::Mem::at(regs.next()?)),
4415        // The rule that writes this has a guard saying the constant fits, so a displacement that
4416        // does not is a rule and a target that disagree rather than a program this cannot compile.
4417        x86_64::Address::BaseOffset => {
4418            Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
4419        }
4420    }
4421}
4422
4423/// The table this selector matches with.
4424///
4425/// One target for now, because one target has a rule file. Which table to use becomes a question
4426/// the moment a second one does, and the answer will be the target the session was given rather
4427/// than a constant here.
4428static TABLE: &Table = &crate::select::x86_64::TABLE;
4429
4430#[cfg(test)]
4431mod tests {
4432    use rucc_ir::{
4433        AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
4434    };
4435    use rucc_regalloc::assign::Env;
4436    use rucc_target::x86_64::{FRAME, REGS, SYSV};
4437
4438    use super::*;
4439    use crate::finish::{Convention, finish};
4440    use crate::frame::{Frame, Incoming, Layout};
4441
4442    /// A function of as many 64 bit parameters as the test wants, and the block they are in.
4443    fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
4444        let mut names = Interner::new();
4445        let mut func = Func::new(names.intern("f"), Signature::new());
4446        let block = func.create_block();
4447        let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
4448        (names, func, block, values)
4449    }
4450
4451    /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
4452    /// Neither field reaches selection, which is the point of saying it once here.
4453    fn plain() -> MemInfo {
4454        MemInfo {
4455            size: 0,
4456            align: 1,
4457            order: MemOrder::NotAtomic,
4458            tbaa: None,
4459            owns: 0,
4460            restrict: Restrict::NONE,
4461        }
4462    }
4463
4464    /// What the allocator is given: every integer register the convention offers except two, held
4465    /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
4466    /// somewhere to be read into. Which two does not matter, and holding back the last two the
4467    /// convention would reach for leaves every expectation below unchanged.
4468    fn env() -> Env {
4469        const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
4470        let order: Vec<PhysReg> =
4471            SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
4472        Env::new().with(x86_64::GPR, &order, &SCRATCH)
4473    }
4474
4475    /// The machine IR text a function lowers to.
4476    fn lower(names: &mut Interner, source: &Func) -> String {
4477        let out = func(source, names, &SYSV, &Elsewhere::default())
4478            .expect("every instruction has a rule");
4479        mir::print_func(&out.func, names, &REGS)
4480    }
4481
4482    #[test]
4483    fn an_addition_of_two_registers_is_one_instruction() {
4484        let i32 = Type::int(32);
4485        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4486        let mut build = Builder::new(&mut func, block);
4487        build.binary(Opcode::Add, args[0], args[1], Flags::default());
4488
4489        assert_eq!(
4490            lower(&mut names, &func),
4491            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4492             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
4493        );
4494    }
4495
4496    #[test]
4497    fn a_constant_operand_becomes_an_immediate() {
4498        let i32 = Type::int(32);
4499        let (mut names, mut func, block, args) = blank(&[i32]);
4500        let mut build = Builder::new(&mut func, block);
4501        let seven = build.iconst(i32, 7);
4502        build.binary(Opcode::Add, args[0], seven, Flags::default());
4503
4504        // The constant is in the instruction and nothing was written to hold it, which is what
4505        // materializing one where a register for it is wanted buys.
4506        assert_eq!(
4507            lower(&mut names, &func),
4508            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4509             %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
4510        );
4511    }
4512
4513    #[test]
4514    fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
4515        let i64 = Type::int(64);
4516        let (mut names, mut func, block, args) = blank(&[i64]);
4517        let mut build = Builder::new(&mut func, block);
4518        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
4519        build.binary(Opcode::Add, args[0], big, Flags::default());
4520
4521        // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
4522        // turns a number this wide down, so it does not fire, and the next way of showing the
4523        // operand puts it in a register.
4524        assert_eq!(
4525            lower(&mut names, &func),
4526            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4527             %1:gpr = x64.mov_ri_64 2147483648\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
4528        );
4529    }
4530
4531    #[test]
4532    fn an_index_calculation_folds_into_an_address() {
4533        let i64 = Type::int(64);
4534        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4535        let mut build = Builder::new(&mut func, block);
4536        let four = build.iconst(i64, 4);
4537        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4538        build.binary(Opcode::Add, args[0], scaled, Flags::default());
4539
4540        // Three IR instructions and one machine instruction. The multiply is gone because the
4541        // rule that matched reached down and took it.
4542        assert_eq!(
4543            lower(&mut names, &func),
4544            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4545             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
4546        );
4547    }
4548
4549    #[test]
4550    fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
4551        let i64 = Type::int(64);
4552        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4553        let mut build = Builder::new(&mut func, block);
4554        let four = build.iconst(i64, 4);
4555        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4556        let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
4557        build.binary(Opcode::Add, first, scaled, Flags::default());
4558
4559        // Both readers have room for a scaled index, so both of them take it and nothing is left
4560        // to read the multiply. Three IR instructions become two machine ones, where refusing to
4561        // fold into either reader would have left three.
4562        assert_eq!(
4563            lower(&mut names, &func),
4564            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4565             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.lea_64 [%0 + %1*4]\n    \
4566             %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
4567        );
4568    }
4569
4570    #[test]
4571    fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
4572        let i64 = Type::int(64);
4573        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4574        let mut build = Builder::new(&mut func, block);
4575        let four = build.iconst(i64, 4);
4576        let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
4577        build.binary(Opcode::Add, args[0], scaled, Flags::default());
4578        build.store(scaled, args[0], plain(), Flags::default());
4579
4580        // The addition has room for the multiply and the store does not: what a store writes is
4581        // a register, and no rule reaches through it. Folding into the addition alone would
4582        // leave the multiply where it is for the store to read and do the work twice, so the
4583        // multiply is put back and both readers read the register it wrote.
4584        let text = lower(&mut names, &func);
4585        assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
4586        assert!(text.contains("x64.add_rr_64"), "{text}");
4587    }
4588
4589    #[test]
4590    fn a_shift_by_a_register_asks_for_it_in_cl() {
4591        let i32 = Type::int(32);
4592        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4593        let mut build = Builder::new(&mut func, block);
4594        build.binary(Opcode::Shl, args[0], args[1], Flags::default());
4595
4596        // The fixed register is not in the rule. It is what the target says the instruction does
4597        // with its operands, and the allocator is what will act on it.
4598        let text = lower(&mut names, &func);
4599        assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
4600    }
4601
4602    #[test]
4603    fn a_division_names_the_registers_and_the_register_it_destroys() {
4604        let i32 = Type::int(32);
4605        let (mut names, mut func, block, args) = blank(&[i32, i32]);
4606        let mut build = Builder::new(&mut func, block);
4607        build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
4608
4609        // Two definitions, because a division writes the remainder whether anybody wanted it or
4610        // not, and the second one is early because it is destroyed before the operands are read.
4611        let text = lower(&mut names, &func);
4612        assert!(
4613            text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
4614            "{text}"
4615        );
4616    }
4617
4618    #[test]
4619    fn a_load_reads_through_the_register_the_address_is_in() {
4620        let i64 = Type::int(64);
4621        let (mut names, mut func, block, args) = blank(&[i64]);
4622        let mut build = Builder::new(&mut func, block);
4623        build.load(Type::int(32), args[0], plain(), Flags::default());
4624
4625        assert_eq!(
4626            lower(&mut names, &func),
4627            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4628             %1:gpr = x64.mov_rm_32 [%0]\n}\n"
4629        );
4630    }
4631
4632    #[test]
4633    fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
4634        let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
4635        let mut build = Builder::new(&mut func, block);
4636        build.store(args[0], args[1], plain(), Flags::default());
4637
4638        // The value is the first parameter and the address is the second, and the instruction
4639        // takes them the other way round. Getting that backwards would compile to a store of the
4640        // address into the value, which is a program that runs and does the wrong thing.
4641        assert_eq!(
4642            lower(&mut names, &func),
4643            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4644             %1:gpr($rsi) = x64.arg_val_64\n    x64.mov_mr_32 %0, [%1]\n}\n"
4645        );
4646    }
4647
4648    #[test]
4649    fn an_address_with_a_constant_added_folds_into_the_access() {
4650        let i64 = Type::int(64);
4651        let (mut names, mut func, block, args) = blank(&[i64]);
4652        let mut build = Builder::new(&mut func, block);
4653        let twelve = build.iconst(i64, 12);
4654        let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
4655        build.load(Type::int(64), field, plain(), Flags::default());
4656
4657        // Two IR instructions and one machine instruction, which is what every read of a field
4658        // of a structure comes to.
4659        assert_eq!(
4660            lower(&mut names, &func),
4661            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4662             %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
4663        );
4664    }
4665
4666    #[test]
4667    fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
4668        let i64 = Type::int(64);
4669        let (mut names, mut func, block, args) = blank(&[i64]);
4670        let mut build = Builder::new(&mut func, block);
4671        let big = build.iconst(i64, i128::from(i32::MAX) + 1);
4672        let far = build.binary(Opcode::Add, args[0], big, Flags::default());
4673        build.load(Type::int(32), far, plain(), Flags::default());
4674
4675        // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
4676        // this down, so the addition stays and the load reads through what it produced. Nobody
4677        // wrote that fallback: it is the next way of showing the operand.
4678        let text = lower(&mut names, &func);
4679        assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
4680        assert!(text.contains("x64.add_rr_64"), "{text}");
4681    }
4682
4683    #[test]
4684    fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
4685        let i64 = Type::int(64);
4686        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4687        let mut build = Builder::new(&mut func, block);
4688        let got = build.load(Type::int(8), args[0], plain(), Flags::default());
4689        build.store(got, args[1], plain(), Flags::default());
4690
4691        // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
4692        // most one memory operand, and there is no rule that takes two, so the load is left where
4693        // it is and the store reads the register it wrote.
4694        assert_eq!(
4695            lower(&mut names, &func),
4696            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4697             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr = x64.mov_rm_8 [%0]\n    \
4698             x64.mov_mr_8 %2, [%1]\n}\n"
4699        );
4700    }
4701
4702    #[test]
4703    fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
4704        let i64 = Type::int(64);
4705        let (mut names, mut source, block, args) = blank(&[i64]);
4706        let mut build = Builder::new(&mut source, block);
4707        build.load(Type::int(128), args[0], plain(), Flags::default());
4708
4709        // The width is the whole of what is wrong here, so the width is in the message: `load`
4710        // on its own is written about at every other width and would send a reader looking in
4711        // the wrong place.
4712        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
4713            .expect_err("nothing loads 128 bits");
4714        assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
4715    }
4716
4717    #[test]
4718    fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
4719        let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
4720        let mut build = Builder::new(&mut func, block);
4721        build.ret(&[args[0]]);
4722
4723        // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
4724        // is what the target says the instruction does with its operand, and the allocator is
4725        // what will act on it. There is no `ret` here, because giving the frame back has to
4726        // happen between this and leaving and the frame is not worked out yet.
4727        assert_eq!(
4728            lower(&mut names, &func),
4729            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
4730             x64.ret_val_32 %0($rax)\n}\n"
4731        );
4732    }
4733
4734    #[test]
4735    fn a_return_of_two_values_asks_for_the_second_register_as_well() {
4736        let i64 = Type::int(64);
4737        let (mut names, mut func, block, args) = blank(&[i64, i64]);
4738        let mut build = Builder::new(&mut func, block);
4739        build.ret(&[args[0], args[1]]);
4740
4741        // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
4742        // halves are integers, so the second is in the second integer return register, and both
4743        // pseudos say so the same way the one for a single value does.
4744        assert_eq!(
4745            lower(&mut names, &func),
4746            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4747             %1:gpr($rsi) = x64.arg_val_64\n    x64.ret_val_64 %0($rax)\n    \
4748             x64.ret_val2_64 %1($rdx)\n}\n"
4749        );
4750    }
4751
4752    #[test]
4753    fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
4754        let f64 = Type::float(rucc_ir::Float::F64);
4755        let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
4756        let mut build = Builder::new(&mut func, block);
4757        build.ret(&[args[0], args[1]]);
4758
4759        // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
4760        // neither half is the second of anything and the `double` is in `xmm0` rather than in the
4761        // register a second `double` would have been in. Getting this wrong is not a crash: the
4762        // caller reads a register nobody wrote, and this is where that is ruled out.
4763        assert_eq!(
4764            lower(&mut names, &func),
4765            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
4766             %1:gpr($rdi) = x64.arg_val_64\n    x64.ret_val_f64 %0($xmm0)\n    \
4767             x64.ret_val_64 %1($rax)\n}\n"
4768        );
4769    }
4770
4771    #[test]
4772    fn two_of_the_same_file_back_take_the_first_two_of_it() {
4773        let f64 = Type::float(rucc_ir::Float::F64);
4774        let (mut names, mut func, block, args) = blank(&[f64, f64]);
4775        let mut build = Builder::new(&mut func, block);
4776        build.ret(&[args[0], args[1]]);
4777
4778        // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
4779        // above and counts in its own file the same way.
4780        assert_eq!(
4781            lower(&mut names, &func),
4782            "mfunc @f {\nblock0:\n    %0:xmm($xmm0) = x64.arg_val_f64\n    \
4783             %1:xmm($xmm1) = x64.arg_val_f64\n    x64.ret_val_f64 %0($xmm0)\n    \
4784             x64.ret_val2_f64 %1($xmm1)\n}\n"
4785        );
4786    }
4787
4788    /// A function whose answer goes back through memory, with the pointer to the space for it in
4789    /// front of whatever else it takes. Only the signature says it is one.
4790    fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
4791        let mut names = Interner::new();
4792        let sret = Abi::Sret { size: 32, align: 8 };
4793        let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
4794        signature.params.extend(params.iter().copied().map(Param::new));
4795        let mut func = Func::new(names.intern("f"), signature);
4796        let block = func.create_block();
4797        let space = func.append_param(block, Type::PTR);
4798        let values = std::iter::once(space)
4799            .chain(params.iter().map(|&ty| func.append_param(block, ty)))
4800            .collect();
4801        (names, func, block, values)
4802    }
4803
4804    #[test]
4805    fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
4806        let (mut names, mut func, block, _) = returning_through_memory(&[]);
4807        Builder::new(&mut func, block).ret(&[]);
4808
4809        // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
4810        // carries nothing, because the value went into the space the caller handed over, and the
4811        // document still says that address comes back in `rax`. Nothing in the IR says it, so the
4812        // convention says it, and the pseudo is the one any other pointer return would use.
4813        assert_eq!(
4814            lower(&mut names, &func),
4815            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
4816             x64.ret_val_64 %0($rax)\n}\n"
4817        );
4818    }
4819
4820    #[test]
4821    fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
4822        let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
4823        let mut build = Builder::new(&mut func, block);
4824        build.store(args[1], args[0], plain(), Flags::default());
4825        build.ret(&[]);
4826
4827        // The register is a read at the end and not a move at the start, so it is live across
4828        // everything between the two and the allocator has to keep it somewhere. In a function
4829        // with a call in it that somewhere is a callee saved register, and the address comes back
4830        // into `rax` here rather than whatever the last instruction happened to leave there. That
4831        // is issue #333, and a store is enough to show the value outlives the entry block.
4832        let text = lower(&mut names, &func);
4833        assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
4834        assert!(text.ends_with("    x64.ret_val_64 %0($rax)\n}\n"), "{text}");
4835    }
4836
4837    #[test]
4838    fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
4839        let (mut names, mut func, block, args) = blank(&[Type::PTR]);
4840        let mut build = Builder::new(&mut func, block);
4841        build.store(args[0], args[0], plain(), Flags::default());
4842        build.ret(&[]);
4843
4844        // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
4845        // the one above and none of its meaning, and what tells them apart is the signature. A
4846        // `void` function leaves `rax` alone.
4847        assert!(!lower(&mut names, &func).contains("ret_val"));
4848    }
4849
4850    #[test]
4851    fn a_return_of_a_constant_puts_it_in_a_register_first() {
4852        let (mut names, mut func, block, _) = blank(&[]);
4853        let mut build = Builder::new(&mut func, block);
4854        let zero = build.iconst(Type::int(32), 0);
4855        build.ret(&[zero]);
4856
4857        // No rule returns an immediate, so the plan that offers one is turned down and the next
4858        // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
4859        // is appended to it.
4860        assert_eq!(
4861            lower(&mut names, &func),
4862            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
4863        );
4864    }
4865
4866    #[test]
4867    fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
4868        let (mut names, mut func, block, _) = blank(&[]);
4869        let mut build = Builder::new(&mut func, block);
4870        let zero = build.iconst(Type::int(32), 0);
4871        build.ret(&[zero]);
4872
4873        // The loop over the instructions passes a constant by, because a constant is written where
4874        // a register for it is first wanted rather than where the IR put it. So the only place a
4875        // rule about one is ever selected is the materialization, and a mark made in the loop
4876        // alone would report every rule about a constant as a rule nothing reaches.
4877        let out = super::func(&func, &mut names, &SYSV, &Elsewhere::default())
4878            .expect("every instruction has a rule");
4879        let rules = &crate::select::x86_64::TABLE.rules;
4880        let fired: Vec<&str> = rules
4881            .iter()
4882            .enumerate()
4883            .filter(|(index, _)| out.fired.has(*index))
4884            .map(|(_, rule)| rule.pattern)
4885            .collect();
4886        assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
4887    }
4888
4889    #[test]
4890    fn a_return_of_nothing_is_no_instruction_at_all() {
4891        let (mut names, mut func, block, _) = blank(&[]);
4892        let mut build = Builder::new(&mut func, block);
4893        build.ret(&[]);
4894
4895        // Every part of leaving a function that returns nothing is the epilogue's, and the
4896        // epilogue goes in after allocation. A block with nothing in it is the right answer here
4897        // rather than a function that could not be lowered.
4898        assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
4899    }
4900
4901    #[test]
4902    fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
4903        let (mut names, mut source, block, _) = blank(&[]);
4904        let mut build = Builder::new(&mut source, block);
4905        let zero = build.iconst(Type::int(32), 0);
4906        build.ret(&[zero]);
4907
4908        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
4909            .expect("every instruction has a rule")
4910            .func;
4911        let env = env();
4912        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
4913        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
4914        finish(
4915            &mut out,
4916            &allocation,
4917            &frame,
4918            &Stack::default(),
4919            Convention::new(&SYSV, &FRAME),
4920            &mut names,
4921        );
4922
4923        // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
4924        // the value goes back, the target said where, and the allocator is what made it true. The
4925        // epilogue is what leaves, and this function needs no frame, so it is the return alone.
4926        //
4927        // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
4928        // so `rax` is the register the allocator tries first for the value the return reads, and
4929        // the constant is written straight into it.
4930        assert_eq!(
4931            mir::print_func(&out, &names, &REGS),
4932            "mfunc @f {\nblock0:\n    $rax = x64.mov_ri_32 0\n    \
4933             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
4934        );
4935    }
4936
4937    #[test]
4938    fn a_function_of_two_arguments_is_a_whole_function_now() {
4939        let i32 = Type::int(32);
4940        let (mut names, mut source, block, args) = blank(&[i32, i32]);
4941        let mut build = Builder::new(&mut source, block);
4942        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
4943        build.ret(&[sum]);
4944
4945        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
4946            .expect("every instruction has a rule")
4947            .func;
4948        let env = env();
4949        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
4950        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
4951        finish(
4952            &mut out,
4953            &allocation,
4954            &frame,
4955            &Stack::default(),
4956            Convention::new(&SYSV, &FRAME),
4957            &mut names,
4958        );
4959
4960        // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
4961        // side exists for. Before it there was no way to write one: the allocator refuses a
4962        // function whose entry block takes parameters, because there is no edge into an entry
4963        // block for the moves that give a block parameter its value to go on.
4964        //
4965        // One move, and it is the one the machine's addition needs rather than one the allocator
4966        // owes anybody. Each argument stays in the register it arrived in, because the pseudo
4967        // that defines it insists on that register and the allocator now tries it first, and the
4968        // sum stays in the register the addition wrote it to until the return reads it out. The
4969        // copy in front of a two address instruction is what makes its destination one of the
4970        // registers it reads, and the source operand keeps its own name because the destination
4971        // is what the encoder writes.
4972        assert_eq!(
4973            mir::print_func(&out, &names, &REGS),
4974            "mfunc @f {\nblock0:\n    $rdi($rdi) = x64.arg_val_32\n    \
4975             $rsi($rsi) = x64.arg_val_32\n    \
4976             $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n    $rax = x64.mov_rr_64 $rdi\n    \
4977             x64.ret_val_32 $rax($rax)\n    x64.ret\n}\n"
4978        );
4979    }
4980
4981    #[test]
4982    fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
4983        let i64 = Type::int(64);
4984        let (mut names, mut source, block, args) = blank(&[i64; 7]);
4985        let mut build = Builder::new(&mut source, block);
4986        build.ret(&[args[6]]);
4987
4988        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
4989            .expect("the seventh is read from memory");
4990
4991        // SysV passes six integers in registers and the seventh in the caller's memory, so six of
4992        // these are pseudos that encode to nothing and the seventh is a load that encodes to real
4993        // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
4994        // yet. What the walk hands on is which instruction is waiting, and for how far up the
4995        // caller's argument area, which is the bottom of it because it is the first one there.
4996        assert_eq!(lowered.stack.arguments.len(), 1);
4997        assert_eq!(lowered.stack.arguments[0].1, 0);
4998        let text = mir::print_func(&lowered.func, &names, &REGS);
4999        assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
5000        assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
5001    }
5002
5003    #[test]
5004    fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
5005        let i64 = Type::int(64);
5006        let (mut names, mut source, block, args) = blank(&[i64; 8]);
5007        let mut build = Builder::new(&mut source, block);
5008        let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
5009        build.ret(&[sum]);
5010
5011        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5012            .expect("both are read from memory");
5013        let stack = lowered.stack;
5014        let mut out = lowered.func;
5015        let env = env();
5016        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5017        let layout = stack.layout(Layout::new(&SYSV, REGS));
5018        let frame = Frame::of(&out, &allocation, &layout);
5019        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5020
5021        // A leaf that takes no frame, so the stack pointer never moves and the only thing between
5022        // it and the caller's arguments is the return address the call pushed. The seventh
5023        // parameter is at the bottom of the caller's argument area and the eighth is one word
5024        // further up, which is the eight bytes between the two offsets.
5025        let text = mir::print_func(&out, &names, &REGS);
5026        assert_eq!(frame.size(), 0);
5027        assert_eq!(frame.incoming(), Incoming::from_stack(8));
5028        assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
5029        assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
5030    }
5031
5032    #[test]
5033    fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
5034        let i64 = Type::int(64);
5035        let (mut names, mut source, block, args) = blank(&[i64; 7]);
5036        let wide = slot(&mut source, block, 64, 32);
5037        let mut build = Builder::new(&mut source, block);
5038        build.store(args[6], wide, plain(), Flags::default());
5039        build.ret(&[args[6]]);
5040
5041        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5042            .expect("every instruction has a rule");
5043        let stack = lowered.stack;
5044        let mut out = lowered.func;
5045        let env = env();
5046        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5047        let layout = stack.layout(Layout::new(&SYSV, REGS));
5048        let frame = Frame::of(&out, &allocation, &layout);
5049        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5050
5051        // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
5052        // which throws away how far the caller's stack was. So the load the lowering wrote off the
5053        // stack pointer is rewritten to read through the frame pointer, at the one distance that
5054        // survives: the word the prologue pushed the frame pointer into, and the return address
5055        // above it.
5056        let text = mir::print_func(&out, &names, &REGS);
5057        assert_eq!(frame.realign(), Some(32));
5058        assert_eq!(frame.incoming(), Incoming::from_frame(16));
5059        assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
5060        assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
5061    }
5062
5063    #[test]
5064    fn a_jump_is_the_edge_and_nothing_else() {
5065        let i32 = Type::int(32);
5066        let (mut names, mut source, entry, args) = blank(&[i32]);
5067        let next = source.create_block();
5068        let got = source.append_param(next, i32);
5069        Builder::new(&mut source, entry).jump(next, &[args[0]]);
5070        Builder::new(&mut source, next).ret(&[got]);
5071
5072        // Two blocks and two instructions, and the jump is neither of them. What it was is the
5073        // arm on the first block, and what the arm carries is the argument it was called with.
5074        assert_eq!(
5075            lower(&mut names, &source),
5076            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
5077             block1(%1:gpr):\n    x64.ret_val_32 %1($rax)\n}\n"
5078        );
5079    }
5080
5081    /// A block that reads what a block below it writes is filled after it, not before it.
5082    ///
5083    /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
5084    /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
5085    /// Filling them in the order they are written reaches the read in `early` first, and reading
5086    /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
5087    /// what it does is give its answer the register its operand is already in, and that is not
5088    /// the register the read minted. Nothing writes the register the read minted. The printer
5089    /// says `%?` for a register nothing defines, which is what this looks for, and what came out
5090    /// of the real bug was SQLite loading a stack slot no store ever reached.
5091    #[test]
5092    fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
5093        let i64 = Type::int(64);
5094        let (mut names, mut source, entry, args) = blank(&[i64, i64]);
5095        let early = source.create_block();
5096        let late = source.create_block();
5097        let exit = source.create_block();
5098
5099        Builder::new(&mut source, entry).jump(late, &[]);
5100        let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
5101        Builder::new(&mut source, early).ret(&[ptr]);
5102        let mut build = Builder::new(&mut source, late);
5103        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5104        build.br_if(cond, early, &[], exit, &[]);
5105        Builder::new(&mut source, exit).ret(&[args[1]]);
5106
5107        let text = lower(&mut names, &source);
5108        assert!(!text.contains("%?"), "every register has something that writes it: {text}");
5109    }
5110
5111    /// A constant is written where it is wanted rather than where the IR defined it, and two
5112    /// blocks wanting the same one is two places. Writing it once and reading it in both is a
5113    /// register read where nothing wrote it, unless the block it was written in happens to
5114    /// dominate the other, which nothing here checks and which the second arm of a branch never
5115    /// does. Each block gets its own copy of the number instead.
5116    #[test]
5117    fn a_constant_two_blocks_want_is_written_in_both_of_them() {
5118        let i32 = Type::int(32);
5119        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5120        let then = source.create_block();
5121        let other = source.create_block();
5122        let join = source.create_block();
5123        let got = source.append_param(join, i32);
5124
5125        let mut build = Builder::new(&mut source, entry);
5126        let seven = build.iconst(i32, 7);
5127        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5128        build.br_if(cond, then, &[], other, &[]);
5129        // Both arms want the seven in a register, because a block argument is never an immediate,
5130        // and neither arm dominates the other.
5131        Builder::new(&mut source, then).jump(join, &[seven]);
5132        Builder::new(&mut source, other).jump(join, &[seven]);
5133        Builder::new(&mut source, join).ret(&[got]);
5134
5135        let text = lower(&mut names, &source);
5136        assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
5137    }
5138
5139    /// An argument on an edge out of a block that leaves two ways is read after every instruction
5140    /// of the block is written, and reading one can write an instruction, which would land after
5141    /// the branch that has already jumped past it. The branch goes back on the end.
5142    #[test]
5143    fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
5144        let i32 = Type::int(32);
5145        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5146        let then = source.create_block();
5147        let join = source.create_block();
5148        let got = source.append_param(join, i32);
5149
5150        let mut build = Builder::new(&mut source, entry);
5151        let nine = build.iconst(i32, 9);
5152        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5153        build.br_if(cond, then, &[], join, &[nine]);
5154        Builder::new(&mut source, then).jump(join, &[args[0]]);
5155        Builder::new(&mut source, join).ret(&[got]);
5156
5157        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5158            .expect("every instruction has a rule")
5159            .func;
5160        let entry = out.entry().expect("an entry block");
5161        let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
5162        let branch = names.intern("x64.br_cond_8");
5163        assert_eq!(
5164            out[last].opcode,
5165            mir::Opcode::new(branch),
5166            "the branch is last: {}",
5167            mir::print_func(&out, &names, &REGS)
5168        );
5169    }
5170
5171    #[test]
5172    fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
5173        let i32 = Type::int(32);
5174        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5175        let then = source.create_block();
5176        let other = source.create_block();
5177        let mut build = Builder::new(&mut source, entry);
5178        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5179        build.br_if(cond, then, &[], other, &[]);
5180        Builder::new(&mut source, then).ret(&[args[0]]);
5181        Builder::new(&mut source, other).ret(&[args[1]]);
5182
5183        // The comparison writes a byte and the branch reads it, and neither says a block. Both
5184        // arms are on the entry block, in the order the branch took them, so the arm that runs
5185        // when the condition holds is the first.
5186        assert_eq!(
5187            lower(&mut names, &source),
5188            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5189             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
5190             x64.br_cond_8 %2, block1, block2\n\n\
5191             block1:\n    x64.ret_val_32 %0($rax)\n\n\
5192             block2:\n    x64.ret_val_32 %1($rax)\n}\n"
5193        );
5194    }
5195
5196    /// A choice between two values, which is one instruction and no blocks at all.
5197    ///
5198    /// The arms come out the other way round from the IR, because a conditional move overwrites its
5199    /// destination and the destination is the arm taken when the condition does not hold. The
5200    /// condition arrives last for the same reason: it is read by the test in front of the move
5201    /// rather than by the move.
5202    #[test]
5203    fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
5204        let i32 = Type::int(32);
5205        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5206        let mut build = Builder::new(&mut source, entry);
5207        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5208        let picked = build.select(cond, args[0], args[1]);
5209        build.ret(&[picked]);
5210
5211        assert_eq!(
5212            lower(&mut names, &source),
5213            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
5214             %1:gpr($rsi) = x64.arg_val_32\n    %2:gpr = x64.cmp_set_l_32 %0, %1\n    \
5215             %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n    \
5216             x64.ret_val_32 %3($rax)\n}\n"
5217        );
5218    }
5219
5220    #[test]
5221    fn a_branch_over_a_block_is_a_whole_function_now() {
5222        let i32 = Type::int(32);
5223        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5224        let then = source.create_block();
5225        let other = source.create_block();
5226        let join = source.create_block();
5227        let got = source.append_param(join, i32);
5228        let mut build = Builder::new(&mut source, entry);
5229        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5230        build.br_if(cond, then, &[], other, &[]);
5231        let mut build = Builder::new(&mut source, then);
5232        let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
5233        build.jump(join, &[sum]);
5234        Builder::new(&mut source, other).jump(join, &[args[1]]);
5235        Builder::new(&mut source, join).ret(&[got]);
5236
5237        // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
5238        // the way a front end writes it: both arms of the branch are blocks of their own and the
5239        // return is the block they meet at. No edge here is critical, because the two arms out of
5240        // the entry carry nothing and the two arms into the join each leave a block that goes
5241        // nowhere else, so each has its own end to put its move at.
5242        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5243            .expect("every instruction has a rule")
5244            .func;
5245        assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
5246        let env = env();
5247        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5248        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5249        finish(
5250            &mut out,
5251            &allocation,
5252            &frame,
5253            &Stack::default(),
5254            Convention::new(&SYSV, &FRAME),
5255            &mut names,
5256        );
5257
5258        // One epilogue, on the join, which is the one block the function leaves from, and the
5259        // moves that give the join its parameter are at the end of each arm. Every register is
5260        // physical and the branch is still a branch on a register, because turning it into a
5261        // `test` and a `jcc` is the block layout's and there is no block layout yet.
5262        let text = mir::print_func(&out, &names, &REGS);
5263        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
5264        assert!(text.contains("x64.br_cond_8"), "{text}");
5265        assert!(text.contains("x64.add_rr_32"), "{text}");
5266        assert!(!text.contains('%'), "{text}");
5267    }
5268
5269    #[test]
5270    fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
5271        let i32 = Type::int(32);
5272        let (mut names, mut source, entry, args) = blank(&[i32, i32]);
5273        let then = source.create_block();
5274        let join = source.create_block();
5275        let got = source.append_param(join, i32);
5276        let mut build = Builder::new(&mut source, entry);
5277        let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
5278        build.br_if(cond, then, &[], join, &[args[1]]);
5279        Builder::new(&mut source, then).jump(join, &[args[0]]);
5280        let mut build = Builder::new(&mut source, join);
5281        let twice = build.binary(Opcode::Add, got, got, Flags::default());
5282        build.ret(&[twice]);
5283
5284        // The else arm is critical: the entry block leaves two ways and the join is arrived at
5285        // two ways, and the arm carries a value. Without splitting it the allocator asserts,
5286        // because the move that gives the join its parameter would have to run at the end of a
5287        // block that also goes to the other arm.
5288        let mut out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5289            .expect("every instruction has a rule")
5290            .func;
5291        assert_eq!(crate::split::critical(&mut out), 1);
5292        let env = env();
5293        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5294        let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
5295        finish(
5296            &mut out,
5297            &allocation,
5298            &frame,
5299            &Stack::default(),
5300            Convention::new(&SYSV, &FRAME),
5301            &mut names,
5302        );
5303
5304        // The block the split added is where the move went, and it is the whole of that block.
5305        let text = mir::print_func(&out, &names, &REGS);
5306        assert_eq!(out.block_count(), 4, "{text}");
5307        assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
5308    }
5309
5310    #[test]
5311    fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
5312        let i32 = Type::int(32);
5313        let (mut names, mut source, block, args) = blank(&[i32, i32]);
5314        let sig =
5315            source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
5316        let callee = names.intern("g");
5317        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
5318        let got = source[call].first_result.expect("an integer comes back");
5319        Builder::new(&mut source, block).ret(&[got]);
5320
5321        // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
5322        // them, so what the call reads is what arrived, and the whole of the convention is in the
5323        // constraints rather than in a move.
5324        let text = lower(&mut names, &source);
5325        assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
5326        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
5327        // What the call writes is the value that comes back and then every register the callee is
5328        // free to destroy, in both classes, which is the whole of what stops the allocator from
5329        // leaving something in one of them.
5330        assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
5331        assert!(text.contains("$xmm15 = x64.call"), "{text}");
5332    }
5333
5334    #[test]
5335    fn what_the_frame_owes_a_call_comes_back_with_the_function() {
5336        let i32 = Type::int(32);
5337        let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
5338
5339        let (mut names, mut source, block, args) = blank(&[i32]);
5340        let sig = sig(&mut source);
5341        let callee = names.intern("g");
5342        Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
5343        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5344            .expect("every instruction has a rule");
5345
5346        // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
5347        // owes the callee an aligned stack pointer and may not use the red zone.
5348        assert_eq!(out.stack.calls, Some(0));
5349        let layout = out.stack.layout(Layout::new(&SYSV, REGS));
5350        assert!(!layout.leaf);
5351        assert_eq!(layout.outgoing, 0);
5352
5353        // The same call under the other convention owes thirty two bytes for the callee to spill
5354        // its register arguments into, which is a fact about the convention and not about the call.
5355        let out = func(&source, &mut names, &x86_64::WIN64, &Elsewhere::default())
5356            .expect("every instruction has a rule");
5357        assert_eq!(out.stack.calls, Some(32));
5358
5359        // And a function that calls nothing is a leaf, which is what says it may use the red zone.
5360        let (mut names, mut source, block, args) = blank(&[i32]);
5361        Builder::new(&mut source, block).ret(&[args[0]]);
5362        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5363            .expect("every instruction has a rule");
5364        assert_eq!(out.stack.calls, None);
5365        assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
5366    }
5367
5368    /// A Windows variadic prologue writes the argument registers the signature did not name into
5369    /// the shadow space the caller already reserved, which makes every argument one run of words up
5370    /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
5371    /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
5372    #[test]
5373    fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
5374        let mut names = Interner::new();
5375        let params = [Type::int(32), Type::PTR];
5376        let signature = Signature::new().with_params(&params).variadic();
5377        let mut source = Func::new(names.intern("f"), signature);
5378        let block = source.create_block();
5379        let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
5380        let mut build = Builder::new(&mut source, block);
5381        let args = build.func().push_values(&values[1..]);
5382        build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
5383        build.ret(&[]);
5384
5385        let out = func(&source, &mut names, &x86_64::WIN64, &Elsewhere::default())
5386            .expect("every instruction has a rule");
5387        let text = mir::print_func(&out.func, &names, &REGS);
5388
5389        // Two named parameters, so the registers at the next two positions hold arguments nobody
5390        // named and both are written up into the caller's area. The displacement is empty here and
5391        // `finish` fills it in, the same way it does for a parameter the registers ran out before.
5392        assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
5393        assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
5394        assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
5395        assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
5396
5397        // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
5398        // sixteen bytes up, which is where the two arguments the signature does name stopped.
5399        assert_eq!(out.stack.arguments.len(), 3);
5400        assert_eq!(out.stack.arguments[2].1, 16);
5401    }
5402
5403    #[test]
5404    fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
5405        let i32 = Type::int(32);
5406        let (mut names, mut source, block, args) = blank(&[i32]);
5407        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
5408        let callee = names.intern("g");
5409        let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
5410        let got = source[call].first_result.expect("an integer comes back");
5411        let mut build = Builder::new(&mut source, block);
5412        let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
5413        build.ret(&[sum]);
5414
5415        // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
5416        // question: `a` is read after the call and `rdi` is a register the call destroys.
5417        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5418            .expect("every instruction has a rule");
5419        let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
5420        let mut out = lowered.func;
5421        let env = env();
5422        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5423        let frame = Frame::of(&out, &allocation, &layout);
5424        finish(
5425            &mut out,
5426            &allocation,
5427            &frame,
5428            &Stack::default(),
5429            Convention::new(&SYSV, &FRAME),
5430            &mut names,
5431        );
5432
5433        // It went to a register the callee has to put back, and the prologue and epilogue are what
5434        // put it back, which is the whole bargain the two halves of a convention make.
5435        let text = mir::print_func(&out, &names, &REGS);
5436        assert!(text.contains("$rbx"), "{text}");
5437        assert!(!text.contains('%'), "{text}");
5438        assert_eq!(text.matches("x64.call").count(), 1, "{text}");
5439    }
5440
5441    #[test]
5442    fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
5443        let i64 = Type::int(64);
5444        let (mut names, mut source, block, args) = blank(&[i64]);
5445        let seven = vec![i64; 7];
5446        let sig = source.add_signature(Signature::new().with_params(&seven));
5447        let callee = names.intern("g");
5448        let passed = vec![args[0]; 7];
5449        Builder::new(&mut source, block).call(callee, sig, &passed);
5450
5451        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5452            .expect("the seventh goes to memory");
5453        // The bytes the call needs are on the layout the frame is worked out from, so that the
5454        // frame reserves as many as the widest call in the function asked for.
5455        assert_eq!(lowered.stack.calls, Some(8));
5456        let text = mir::print_func(&lowered.func, &names, &REGS);
5457        assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
5458    }
5459
5460    #[test]
5461    fn a_call_this_cannot_make_is_reported_rather_than_made() {
5462        let (mut names, mut source, block, _) = blank(&[]);
5463        let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
5464        let sig = source.add_signature(Signature::new().with_returns(&returns));
5465        let callee = names.intern("g");
5466        Builder::new(&mut source, block).call(callee, sig, &[]);
5467        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5468            .expect_err("a long double is on the x87");
5469        assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
5470    }
5471
5472    /// A `long double` on its own is a different answer, because on its own it comes back on the
5473    /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
5474    ///
5475    /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
5476    /// straight after it. That instruction has to be straight after it: the stack is one place and
5477    /// anything else that touched it before this ran would be looking at the value still on it.
5478    #[test]
5479    fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
5480        let (mut names, mut source, block, _) = blank(&[]);
5481        let long_double = Type::float(rucc_ir::Float::F80);
5482        let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
5483        let callee = names.intern("g");
5484        Builder::new(&mut source, block).call(callee, sig, &[]);
5485
5486        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5487            .expect("the value comes back in st0");
5488        let text = mir::print_func(&lowered.func, &names, &REGS);
5489        let after: Vec<&str> =
5490            text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
5491        assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
5492        assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
5493        // And the slot it went into is the sixteen bytes the type takes, like every other one.
5494        assert_eq!(lowered.stack.locals.len(), 1, "{text}");
5495        assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
5496    }
5497
5498    #[test]
5499    fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
5500        let i32 = Type::int(32);
5501        let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
5502        let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
5503        let varargs = source.push_abis(&[]);
5504        let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
5505        let mut build = Builder::new(&mut source, block);
5506        let inst = InstData {
5507            args: build.func().push_values(&[args[0], args[1]]),
5508            extra: Extra::Call(info),
5509            ..InstData::new(Opcode::CallIndirect)
5510        };
5511        let called = build.inst(inst, &[i32]);
5512        let got = source[called].first_result.expect("an integer comes back");
5513        Builder::new(&mut source, block).ret(&[got]);
5514
5515        // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
5516        // the arguments are the ones behind it, and everything else about the call is what a call
5517        // to a name would have been.
5518        let text = lower(&mut names, &source);
5519        assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
5520        assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
5521        assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
5522    }
5523
5524    #[test]
5525    fn an_instruction_no_rule_covers_is_reported() {
5526        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
5527        let mut build = Builder::new(&mut source, block);
5528        let operands = build.func().push_values(&[args[0]]);
5529        build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
5530
5531        // The mark that an object has come into being, which nothing writes an instruction for
5532        // yet: what it needs is a write over a range of the lifetime plane, and that is
5533        // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
5534        // message to add beyond the name.
5535        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5536            .expect_err("no rule writes the beginning of a lifetime");
5537        assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
5538
5539        // It produces nothing, so there is no type in the message and nothing invents one, and the
5540        // instruction comes back so a caller can ask the function where it was.
5541        let inst = failed.inst().expect("the instruction it is about");
5542        assert_eq!(source[inst].opcode, Opcode::MetaBegin);
5543    }
5544
5545    /// A barrier is written by name here, and what it is depends on the ordering and on nothing
5546    /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
5547    #[test]
5548    fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
5549        for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
5550            let (mut names, mut source, block, _) = blank(&[]);
5551            let mut build = Builder::new(&mut source, block);
5552            build
5553                .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
5554
5555            let text = lower(&mut names, &source);
5556            assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
5557        }
5558    }
5559
5560    /// A compare and exchange is written by name too, and at the width of the value rather than at
5561    /// the width of the address, which is the mistake worth pinning: everything here is a pointer
5562    /// and only the value says how many bytes the instruction touches.
5563    #[test]
5564    fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
5565        for bits in [8, 16, 32, 64] {
5566            let ty = Type::int(bits);
5567            let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
5568            let mut build = Builder::new(&mut source, block);
5569            let mem = build.func().add_mem(MemInfo {
5570                size: u64::from(bits / 8),
5571                align: bits / 8,
5572                order: MemOrder::SeqCst,
5573                ..plain()
5574            });
5575            let operands = build.func().push_values(&[args[0], args[1], args[2]]);
5576            build.inst(
5577                InstData {
5578                    args: operands,
5579                    extra: Extra::Mem(mem),
5580                    ..InstData::new(Opcode::Cmpxchg)
5581                },
5582                &[ty, Type::I1],
5583            );
5584
5585            // Two values out of one instruction, the first of them in the register the machine
5586            // reads the expected value out of, the second free for the allocator to place. The
5587            // address is the memory operand and neither of the two values is.
5588            let text = lower(&mut names, &source);
5589            let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
5590            assert!(text.contains(&written), "{bits}: {text}");
5591        }
5592    }
5593
5594    #[test]
5595    fn more_values_back_than_the_convention_has_registers_for_is_reported() {
5596        let i64 = Type::int(64);
5597        let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
5598        let mut build = Builder::new(&mut source, block);
5599        build.ret(&[args[0], args[1], args[2]]);
5600
5601        // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
5602        // gap in the rules but the convention saying no. The front end classifies before it gets
5603        // here, so this is the shape that would mean the classification went wrong.
5604        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5605            .expect_err("only two come back");
5606        assert_eq!(
5607            failed.to_string(),
5608            "what this function gives back takes more registers than this convention has for it"
5609        );
5610
5611        let inst = failed.inst().expect("the instruction it is about");
5612        assert_eq!(source[inst].opcode, Opcode::Return);
5613    }
5614
5615    /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
5616    ///
5617    /// Everything else is about something written somewhere in the body and hands it back so a
5618    /// caller can ask the function where it came from. A parameter arrives before the first
5619    /// instruction runs, so there is nothing in the body to point at and the message is about
5620    /// the function.
5621    #[test]
5622    fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
5623        let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
5624        assert_eq!(missing.inst(), None);
5625    }
5626
5627    /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
5628    fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
5629        let info = MemInfo { size, align, ..plain() };
5630        let mut build = Builder::new(source, block);
5631        let mem = build.func().add_mem(info);
5632        build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
5633    }
5634
5635    #[test]
5636    fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
5637        let (mut names, mut source, block, _) = blank(&[]);
5638        let slot = slot(&mut source, block, 4, 4);
5639        let mut build = Builder::new(&mut source, block);
5640        let nine = build.iconst(Type::int(32), 9);
5641        build.store(nine, slot, plain(), Flags::default());
5642        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
5643        build.ret(&[loaded]);
5644
5645        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5646            .expect("every instruction has a rule");
5647
5648        // Four bytes on the list the frame is laid out from, and the one instruction that reads
5649        // where they went. Its displacement is nothing here because there is no frame yet, and
5650        // which instruction is waiting for which local is what `finish` is handed.
5651        assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
5652        assert_eq!(lowered.stack.addresses.len(), 1);
5653        assert_eq!(lowered.stack.addresses[0].1, 0);
5654        assert_eq!(
5655            mir::print_func(&lowered.func, &names, &REGS),
5656            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [$rsp]\n    \
5657             %1:gpr = x64.mov_ri_32 9\n    x64.mov_mr_32 %1, [%0]\n    \
5658             %2:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %2($rax)\n}\n"
5659        );
5660    }
5661
5662    #[test]
5663    fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
5664        let (mut names, mut source, block, _) = blank(&[]);
5665        let scratch = slot(&mut source, block, 4, 4);
5666        let mut build = Builder::new(&mut source, block);
5667        let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
5668        let declared = build
5669            .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
5670        build.func().declare_mem(mem, 41);
5671        build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
5672        build.ret(&[]);
5673
5674        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5675            .expect("every instruction has a rule");
5676
5677        // Two locals and one declaration, held against the order the allocas were lowered in,
5678        // which is the only name a local has by the time the frame places it. The scratch one was
5679        // reached first and is local zero, so the declared one is local one.
5680        assert_eq!(lowered.stack.locals.len(), 2);
5681        assert_eq!(lowered.stack.declared, vec![(1, 41)]);
5682    }
5683
5684    #[test]
5685    fn the_frame_is_what_fills_the_address_of_a_local_in() {
5686        let (mut names, mut source, block, _) = blank(&[]);
5687        let slot = slot(&mut source, block, 4, 4);
5688        let mut build = Builder::new(&mut source, block);
5689        let nine = build.iconst(Type::int(32), 9);
5690        build.store(nine, slot, plain(), Flags::default());
5691        let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
5692        build.ret(&[loaded]);
5693
5694        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5695            .expect("every instruction has a rule");
5696        let stack = lowered.stack;
5697        let mut out = lowered.func;
5698        let env = env();
5699        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5700        let layout = stack.layout(Layout::new(&SYSV, REGS));
5701        let frame = Frame::of(&out, &allocation, &layout);
5702        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5703
5704        // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
5705        // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
5706        // never moves and the four bytes are below it, which is what the negative offset is. The
5707        // instruction the lowering left with nothing in its displacement now has the answer in it.
5708        let text = mir::print_func(&out, &names, &REGS);
5709        assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
5710        assert!(!text.contains("x64.sub_ri_64"), "{text}");
5711        assert_eq!(frame.size(), 0);
5712        assert_eq!(frame.local(0), Some(-8));
5713    }
5714
5715    /// An `alloca` whose size is an operand, which is a variable length array.
5716    fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
5717        let info = MemInfo { size: 0, align, ..plain() };
5718        let mut build = Builder::new(source, block);
5719        let mem = build.func().add_mem(info);
5720        let args = build.func().push_values(&[size]);
5721        build.value(
5722            InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
5723            Type::PTR,
5724        )
5725    }
5726
5727    #[test]
5728    fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
5729        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
5730        let slot = growing(&mut source, block, args[0], 16);
5731        Builder::new(&mut source, block).ret(&[slot]);
5732
5733        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5734            .expect("every instruction has a rule");
5735
5736        // The bytes come off the stack pointer where the declaration stands and the address is
5737        // where the stack pointer then is, which is one subtraction and one `lea` rather than a
5738        // slot the frame laid out. Nothing is on the list of locals, because there is nothing
5739        // about this the frame could place.
5740        let text = mir::print_func(&lowered.func, &names, &REGS);
5741        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
5742        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
5743        assert!(lowered.stack.locals.is_empty(), "{text}");
5744        assert_eq!(lowered.stack.dynamic.len(), 1);
5745        assert!(lowered.stack.grown_at.is_some());
5746    }
5747
5748    #[test]
5749    fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
5750        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
5751        let slot = growing(&mut source, block, args[0], 32);
5752        Builder::new(&mut source, block).ret(&[slot]);
5753
5754        // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
5755        // for means masking the stack pointer after moving it, and after that no constant reaches
5756        // the rest of the frame from the frame pointer either. A second pointer held for the
5757        // purpose is what fixes it and there is not one yet.
5758        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
5759            .expect_err("nothing realigns a frame that grows");
5760        assert_eq!(
5761            failed.to_string(),
5762            "this local wants more alignment than the stack pointer is left on, which needs a \
5763             base register nothing here keeps"
5764        );
5765    }
5766
5767    #[test]
5768    fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
5769        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
5770        let fixed = slot(&mut source, block, 4, 4);
5771        let mut build = Builder::new(&mut source, block);
5772        let nine = build.iconst(Type::int(32), 9);
5773        build.store(nine, fixed, plain(), Flags::default());
5774        let grown = growing(&mut source, block, args[0], 16);
5775        Builder::new(&mut source, block).ret(&[grown]);
5776
5777        let lowered = func(&source, &mut names, &SYSV, &Elsewhere::default())
5778            .expect("every instruction has a rule");
5779        let stack = lowered.stack;
5780        let mut out = lowered.func;
5781        let env = env();
5782        let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
5783        let layout = stack.layout(Layout::new(&SYSV, REGS));
5784        let frame = Frame::of(&out, &allocation, &layout);
5785        finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
5786
5787        // The stack pointer moves in the middle of the function, so the four bytes of the fixed
5788        // local are not a constant away from it any more and the frame pointer is what reaches
5789        // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
5790        // living in the red zone, and the address of the growing slot is off the stack pointer as
5791        // it stands after the subtraction rather than off anything the prologue left.
5792        let text = mir::print_func(&out, &names, &REGS);
5793        assert!(frame.grows());
5794        assert!(frame.frame_pointer());
5795        assert!(frame.size() > 0, "{text}");
5796        assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
5797        assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
5798        assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
5799    }
5800
5801    #[test]
5802    fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
5803        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
5804        let mut build = Builder::new(&mut source, block);
5805        let stepped = build.func().push_values(&[args[0], args[1]]);
5806        let next =
5807            build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
5808        let loaded = build.load(Type::int(32), next, plain(), Flags::default());
5809        build.ret(&[loaded]);
5810
5811        // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
5812        // in the rule set, which is the point: the two addresses arrive in registers because an
5813        // address is an integer as wide as one, and the arithmetic on them is the add it always
5814        // was, so every rule written about an add reaches it.
5815        //
5816        // The add stays its own instruction rather than folding into the address the load reads
5817        // from. Two registers with no scale on either is the one addressing mode the rules have no
5818        // load through, because the folds that exist are the displacement one and the scaled ones,
5819        // and this is neither. That is a peephole worth having and not a thing this changes.
5820        assert_eq!(
5821            lower(&mut names, &source),
5822            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
5823             %1:gpr($rsi) = x64.arg_val_64\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
5824             %3:gpr = x64.mov_rm_32 [%2]\n    x64.ret_val_32 %3($rax)\n}\n"
5825        );
5826    }
5827
5828    /// The address of a file scope name, which is what every use of a global and every string
5829    /// literal starts from.
5830    fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
5831        let symbol = names.intern(name);
5832        let mut build = Builder::new(source, block);
5833        build.value(
5834            InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
5835            Type::PTR,
5836        )
5837    }
5838
5839    #[test]
5840    fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
5841        let (mut names, mut source, block, _) = blank(&[]);
5842        let counter = address_of(&mut source, block, &mut names, "counter");
5843        let mut build = Builder::new(&mut source, block);
5844        let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
5845        build.ret(&[loaded]);
5846
5847        // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
5848        // that names no register and carries the symbol, which is what the assembler writes
5849        // relative to `%rip` and what the object writer leaves a relocation for.
5850        assert_eq!(
5851            lower(&mut names, &source),
5852            "mfunc @f {\nblock0:\n    %0:gpr = x64.lea_64 [@counter]\n    \
5853             %1:gpr = x64.mov_rm_32 [%0]\n    x64.ret_val_32 %1($rax)\n}\n"
5854        );
5855    }
5856
5857    #[test]
5858    fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
5859        let (mut names, mut source, block, _) = blank(&[]);
5860        let away = address_of(&mut source, block, &mut names, "away");
5861        Builder::new(&mut source, block).ret(&[away]);
5862        let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
5863
5864        // `extern void away(void); void *f(void) { return away; }`. A load and not an address
5865        // computation, because the distance from here to a name a shared library may be the one
5866        // that defines is not a number any link can work out, and the slot the linker fills in is
5867        // in this program and so is a distance it has.
5868        let out =
5869            func(&source, &mut names, &SYSV, &elsewhere).expect("every instruction has a rule");
5870        assert_eq!(
5871            mir::print_func(&out.func, &names, &REGS),
5872            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [got @away]\n    \
5873             x64.ret_val_64 %0($rax)\n}\n"
5874        );
5875    }
5876
5877    #[test]
5878    fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
5879        let (mut names, mut source, block, _) = blank(&[]);
5880        let own = address_of(&mut source, block, &mut names, "own");
5881        Builder::new(&mut source, block).ret(&[own]);
5882        let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
5883
5884        // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
5885        // the two cases above are one, because there is no address to load or to work out: the
5886        // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
5887        // thread's block starts, and the sum of the two is this thread's copy.
5888        let out =
5889            func(&source, &mut names, &SYSV, &elsewhere).expect("every instruction has a rule");
5890        assert_eq!(
5891            mir::print_func(&out.func, &names, &REGS),
5892            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [thread @own]\n    \
5893             %1:gpr = x64.mov_rm_64 [fs:0]\n    %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n    \
5894             x64.ret_val_64 %2($rax)\n}\n"
5895        );
5896    }
5897
5898    /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
5899    #[test]
5900    fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
5901        let (mut names, mut source, block, _) = blank(&[]);
5902        let here =
5903            Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
5904        Builder::new(&mut source, block).ret(&[here]);
5905
5906        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
5907            .expect("every instruction has a rule");
5908        assert_eq!(
5909            mir::print_func(&out.func, &names, &REGS),
5910            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
5911             x64.ret_val_64 %0($rax)\n}\n"
5912        );
5913    }
5914
5915    /// One `asm` statement, with its template and its constraint list written as a program does.
5916    fn assembly(
5917        source: &mut Func,
5918        block: Block,
5919        names: &mut Interner,
5920        template: &str,
5921        constraints: &str,
5922        args: &[Value],
5923        results: &[Type],
5924    ) -> Inst {
5925        clobbering(source, block, names, template, constraints, "memory", args, results)
5926    }
5927
5928    /// The same with a clobber list of its own, for the statements that are about one.
5929    #[allow(clippy::too_many_arguments)]
5930    fn clobbering(
5931        source: &mut Func,
5932        block: Block,
5933        names: &mut Interner,
5934        template: &str,
5935        constraints: &str,
5936        clobbers: &str,
5937        args: &[Value],
5938        results: &[Type],
5939    ) -> Inst {
5940        let info = AsmInfo {
5941            template: names.intern(template),
5942            constraints: names.intern(constraints),
5943            clobbers: names.intern(clobbers),
5944            targets: rucc_ir::BlockCallList::EMPTY,
5945        };
5946        Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
5947    }
5948
5949    /// What a program asking the processor what it can do writes, which is the instruction whose
5950    /// every operand is a register its text does not name.
5951    #[test]
5952    fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
5953        let u32 = Type::int(32);
5954        let (mut names, mut source, block, _) = blank(&[]);
5955        let zero = Builder::new(&mut source, block).iconst(u32, 0);
5956        let out = clobbering(
5957            &mut source,
5958            block,
5959            &mut names,
5960            "cpuid",
5961            "=a,a",
5962            "ebx,ecx,edx",
5963            &[zero],
5964            &[u32],
5965        );
5966        let produced = source[out].results().next().expect("one result");
5967        Builder::new(&mut source, block).ret(&[produced]);
5968
5969        // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
5970        // every program that has a faster path on some machines writes. Four registers written and
5971        // two read, none of them in the template, all of them out of the description, and the two
5972        // that the letters named are the statement's own. The subleaf is a zero because the
5973        // instruction reads `ecx` and the program said nothing about what is in it. The three
5974        // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
5975        // register with two definitions.
5976        assert_eq!(
5977            lower(&mut names, &source),
5978            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    \
5979             %1:gpr = x64.mov_ri_64 0\n    \
5980             %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
5981             %1($rcx)\n    x64.ret_val_32 %2($rax)\n}\n"
5982        );
5983    }
5984
5985    /// A clobber the instruction does not write itself, which is the case the list is there for.
5986    /// It goes on as a definition of the register, in among the other definitions, because that is
5987    /// the whole of how a machine function says a register is not worth anything after this.
5988    #[test]
5989    fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
5990        let (mut names, mut source, block, _) = blank(&[]);
5991        clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
5992        Builder::new(&mut source, block).ret(&[]);
5993
5994        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    $rsi = x64.pause\n}\n");
5995    }
5996
5997    /// A clobber naming something this has no register for. Refused rather than dropped, since the
5998    /// list is the program saying which registers it may not leave anything in, and an entry
5999    /// nobody read is a register something may still be left in.
6000    #[test]
6001    fn a_clobber_this_has_no_register_for_is_refused() {
6002        let (mut names, mut source, block, _) = blank(&[]);
6003        clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
6004        Builder::new(&mut source, block).ret(&[]);
6005
6006        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6007            .expect_err("there is no such register here");
6008        assert_eq!(
6009            failed.to_string(),
6010            "this `asm` says it destroys a register this has no name for"
6011        );
6012    }
6013
6014    #[test]
6015    fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
6016        let (mut names, mut source, block, _) = blank(&[]);
6017        assembly(&mut source, block, &mut names, "", "", &[], &[]);
6018        Builder::new(&mut source, block).ret(&[]);
6019
6020        // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
6021        // spent on the optimizer, which has finished by now, so what is left is nothing.
6022        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
6023    }
6024
6025    #[test]
6026    fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
6027        let i32 = Type::int(32);
6028        let (mut names, mut source, block, args) = blank(&[i32]);
6029        let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
6030        let produced = source[out].results().next().expect("one result");
6031        Builder::new(&mut source, block).ret(&[produced]);
6032
6033        // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
6034        // value without changing it. The two share a place and the template writes nothing over
6035        // it, so the value comes back out of the register it went in.
6036        assert_eq!(
6037            lower(&mut names, &source),
6038            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6039             x64.ret_val_32 %0($rax)\n}\n"
6040        );
6041    }
6042
6043    #[test]
6044    fn an_output_written_plus_is_the_same_rename() {
6045        let i32 = Type::int(32);
6046        let (mut names, mut source, block, args) = blank(&[i32]);
6047        let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
6048        let produced = source[out].results().next().expect("one result");
6049        Builder::new(&mut source, block).ret(&[produced]);
6050
6051        // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
6052        assert_eq!(
6053            lower(&mut names, &source),
6054            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_32\n    \
6055             x64.ret_val_32 %0($rax)\n}\n"
6056        );
6057    }
6058
6059    #[test]
6060    fn an_output_nothing_is_tied_to_is_a_zero() {
6061        let i32 = Type::int(32);
6062        let (mut names, mut source, block, _) = blank(&[]);
6063        let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
6064        let produced = source[out].results().next().expect("one result");
6065        Builder::new(&mut source, block).ret(&[produced]);
6066
6067        // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
6068        // an empty template leaves nothing. A definite value rather than a register nothing wrote,
6069        // because the allocator is owed a definition before the use however little the program is.
6070        assert_eq!(
6071            lower(&mut names, &source),
6072            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_32 0\n    x64.ret_val_32 %0($rax)\n}\n"
6073        );
6074    }
6075
6076    #[test]
6077    fn a_template_that_is_one_instruction_becomes_that_instruction() {
6078        let (mut names, mut source, block, _) = blank(&[]);
6079        assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
6080        Builder::new(&mut source, block).ret(&[]);
6081
6082        // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
6083        // instruction, no operands, and nothing between the template and the machine but the table
6084        // that already says what a `pause` is.
6085        assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n    x64.pause\n}\n");
6086    }
6087
6088    #[test]
6089    fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
6090        let i64 = Type::int(64);
6091        let (mut names, mut source, block, _) = blank(&[]);
6092        let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
6093        let produced = source[out].results().next().expect("one result");
6094        Builder::new(&mut source, block).ret(&[produced]);
6095
6096        // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
6097        // thread owns. The same instruction `crate::lower` already writes for a thread-local
6098        // variable, reached this time because a program wrote it out by hand.
6099        assert_eq!(
6100            lower(&mut names, &source),
6101            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rm_64 [fs:0]\n    \
6102             x64.ret_val_64 %0($rax)\n}\n"
6103        );
6104    }
6105
6106    #[test]
6107    fn a_template_naming_an_instruction_this_machine_has_not_got_is_refused() {
6108        let (mut names, mut source, block, _) = blank(&[]);
6109        assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
6110        Builder::new(&mut source, block).ret(&[]);
6111
6112        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6113            .expect_err("there is no such instruction");
6114        assert_eq!(
6115            failed.to_string(),
6116            "this `asm` has instructions in its template, which nothing here assembles"
6117        );
6118    }
6119
6120    /// A register the template named is placed as itself, fixed to the register the program wrote
6121    /// down. A register a constraint letter names is a different thing and is placed too, which the
6122    /// test above is about: there the statement said which of its own operands is in the register,
6123    /// and a name in the middle of a template says the register and nothing about any operand.
6124    #[test]
6125    fn a_template_naming_a_register_gets_that_register() {
6126        let i64 = Type::int(64);
6127        let (mut names, mut source, block, _) = blank(&[]);
6128        let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
6129        let produced = source[out].results().next().expect("one result");
6130        Builder::new(&mut source, block).ret(&[produced]);
6131
6132        // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
6133        // The source is the register itself and the destination is one the allocator picks.
6134        assert_eq!(
6135            lower(&mut names, &source),
6136            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_rr_64 $rax($rax)\n    \
6137             x64.ret_val_64 %0($rax)\n}\n"
6138        );
6139    }
6140
6141    /// The half of the same thing every register saving template needs. micropython writes the
6142    /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
6143    /// of that line are a register the template named: the one being stored and the one the address
6144    /// is counted from.
6145    #[test]
6146    fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
6147        let (mut names, mut source, block, _) = blank(&[]);
6148        assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
6149        Builder::new(&mut source, block).ret(&[]);
6150
6151        assert_eq!(
6152            lower(&mut names, &source),
6153            "mfunc @f {\nblock0:\n    x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
6154        );
6155    }
6156
6157    #[test]
6158    fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
6159        let i32 = Type::int(32);
6160        let (mut names, mut source, block, args) = blank(&[i32]);
6161        assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
6162        Builder::new(&mut source, block).ret(&[]);
6163
6164        // An output with no result to be, which is what the front end never writes and what a
6165        // hand written module can. Refused rather than placed by a guess.
6166        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6167            .expect_err("the list and the instruction disagree");
6168        assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
6169    }
6170
6171    /// A cast between a pointer and an integer, at whatever width the result is asked for.
6172    fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
6173        let mut build = Builder::new(source, block);
6174        let args = build.func().push_values(&[from]);
6175        build.value(InstData { args, ..InstData::new(opcode) }, to)
6176    }
6177
6178    #[test]
6179    fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
6180        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6181        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
6182        Builder::new(&mut source, block).ret(&[number]);
6183
6184        // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
6185        // as the machine addresses, so the cast changes what the type system calls the value and
6186        // changes nothing about the value, and the register holding it is the one that held it.
6187        assert_eq!(
6188            lower(&mut names, &source),
6189            "mfunc @f {\nblock0:\n    %0:gpr($rdi) = x64.arg_val_64\n    \
6190             x64.ret_val_64 %0($rax)\n}\n"
6191        );
6192    }
6193
6194    #[test]
6195    fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
6196        let (mut names, mut source, block, _) = blank(&[]);
6197        let mut build = Builder::new(&mut source, block);
6198        let zero = build.iconst(Type::int(64), 0);
6199        let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
6200        Builder::new(&mut source, block).ret(&[null]);
6201
6202        // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
6203        // writes the zero down: a constant is materialized where it is wanted rather than where
6204        // the IR defined it, and without the read there would be no instruction at all.
6205        assert_eq!(
6206            lower(&mut names, &source),
6207            "mfunc @f {\nblock0:\n    %0:gpr = x64.mov_ri_64 0\n    x64.ret_val_64 %0($rax)\n}\n"
6208        );
6209    }
6210
6211    #[test]
6212    fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
6213        let readings = [
6214            (Linkage::External, mir::Binding::Global),
6215            (Linkage::Common, mir::Binding::Global),
6216            (Linkage::Internal, mir::Binding::Local),
6217            (Linkage::Weak, mir::Binding::Weak),
6218            (Linkage::LinkOnce, mir::Binding::Weak),
6219        ];
6220        for (linkage, wanted) in readings {
6221            let (mut names, mut source, block, _) = blank(&[]);
6222            source.linkage = linkage;
6223            Builder::new(&mut source, block).ret(&[]);
6224            let out = func(&source, &mut names, &SYSV, &Elsewhere::default()).expect("a return");
6225            // The narrowing is done here rather than where the object is written, because a
6226            // machine function is all the assembler and the writer are ever handed.
6227            assert_eq!(out.func.binding, wanted, "{linkage:?}");
6228        }
6229    }
6230
6231    /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
6232    /// three of them.
6233    ///
6234    /// Here for the reason the linkage above is here. A machine function is the whole of what the
6235    /// assembler and the object writer are handed, so a fact about the symbol that does not get
6236    /// onto one is a fact that is gone by the time anything could write it down, and the way that
6237    /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
6238    #[test]
6239    fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
6240        let readings = [
6241            (Visibility::Default, mir::Visibility::Default),
6242            (Visibility::Hidden, mir::Visibility::Hidden),
6243            (Visibility::Protected, mir::Visibility::Protected),
6244        ];
6245        for (visibility, wanted) in readings {
6246            let (mut names, mut source, block, _) = blank(&[]);
6247            source.visibility = visibility;
6248            Builder::new(&mut source, block).ret(&[]);
6249            let out = func(&source, &mut names, &SYSV, &Elsewhere::default()).expect("a return");
6250            assert_eq!(out.func.visibility, wanted, "{visibility:?}");
6251        }
6252    }
6253
6254    #[test]
6255    fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
6256        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6257        let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
6258        Builder::new(&mut source, block).ret(&[number]);
6259
6260        // The front end never writes one: it casts at the address width and truncates or extends
6261        // around it, so both of those are the rules they always were. IR from somewhere else that
6262        // does write one is refused rather than compiled to a move that keeps the high half.
6263        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6264            .expect_err("no rule narrows an address");
6265        assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
6266    }
6267
6268    /// The type this machine has no register for.
6269    fn long_double() -> Type {
6270        Type::float(rucc_ir::Float::F80)
6271    }
6272
6273    #[test]
6274    fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
6275        let f64 = Type::float(rucc_ir::Float::F64);
6276        let (mut names, mut source, block, args) = blank(&[f64]);
6277        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6278        let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6279        Builder::new(&mut source, block).ret(&[back]);
6280
6281        // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
6282        // else, so the value is written to the crossing slot, loaded at the format that widens it
6283        // and put in the slot the eighty bit value lives in. Coming back is the same three the
6284        // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
6285        // every address in a frame looks like here until `finish` has the numbers.
6286        assert_eq!(
6287            lower(&mut names, &source),
6288            "mfunc @f {\nblock0:\n    \
6289             %0:xmm($xmm0) = x64.arg_val_f64\n    \
6290             %1:gpr = x64.lea_64 [$rsp]\n    \
6291             %2:gpr = x64.lea_64 [$rsp]\n    \
6292             x64.movsd_mr %0, [%1]\n    \
6293             x64.fld_l [%1]\n    \
6294             x64.fstp_t [%2]\n    \
6295             %3:gpr = x64.lea_64 [$rsp]\n    \
6296             %4:gpr = x64.lea_64 [$rsp]\n    \
6297             x64.fld_t [%3]\n    \
6298             x64.fstp_l [%4]\n    \
6299             %5:xmm = x64.movsd_rm [%4]\n    \
6300             x64.ret_val_f64 %5($xmm0)\n}\n"
6301        );
6302    }
6303
6304    #[test]
6305    fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
6306        let f64 = Type::float(rucc_ir::Float::F64);
6307        let (mut names, mut source, block, args) = blank(&[f64]);
6308        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6309        let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6310        let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
6311        let mut build = Builder::new(&mut source, block);
6312        let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
6313        build.ret(&[sum]);
6314
6315        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
6316            .expect("every instruction is written");
6317
6318        // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
6319        // psABI says one takes and is aligned to, and eight for the crossing, which every group
6320        // in the function shares because nothing is ever left in it. The value's slot is its own
6321        // for the whole function, so reading it twice reads the same sixteen bytes.
6322        assert_eq!(
6323            out.stack.locals,
6324            vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
6325        );
6326    }
6327
6328    #[test]
6329    fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
6330        let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
6331        let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
6332        let back =
6333            cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
6334        Builder::new(&mut source, block).ret(&[back]);
6335
6336        // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
6337        // format, so the conversion is the load and there is no instruction that converts.
6338        let text = lower(&mut names, &source);
6339        assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
6340        assert!(text.contains("x64.fild_ll [%1]"), "{text}");
6341    }
6342
6343    #[test]
6344    fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
6345        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
6346        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6347        let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
6348        Builder::new(&mut source, block).ret(&[whole]);
6349
6350        // The one conversion here with no single instruction behind it. C cuts towards zero and
6351        // the unit rounds the way its control word says, so the word is saved, ORed with the two
6352        // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
6353        // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
6354        let text = lower(&mut names, &source);
6355        let group: Vec<&str> = text
6356            .lines()
6357            .map(str::trim)
6358            .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
6359            .collect();
6360        assert_eq!(
6361            group,
6362            [
6363                "x64.fld_l [%1]",
6364                "x64.fstp_t [%2]",
6365                "x64.fnstcw [%5]",
6366                "%6:gpr = x64.mov_rm_16 [%5]",
6367                "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
6368                "x64.mov_mr_16 %7, [%5 + 2]",
6369                "x64.fldcw [%5 + 2]",
6370                "x64.fld_t [%3]",
6371                "x64.fistp_l [%4]",
6372                "x64.fldcw [%5]",
6373            ],
6374            "{text}"
6375        );
6376    }
6377
6378    #[test]
6379    fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
6380        let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
6381        let mut build = Builder::new(&mut source, block);
6382        let value = build.load(long_double(), args[0], plain(), Flags::default());
6383        build.store(value, args[1], plain(), Flags::default());
6384        build.ret(&[]);
6385
6386        // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
6387        // format the value is already in, which neither converts nor looks: a signalling NaN stays
6388        // one and nothing is raised, which is the whole of what makes it a copy.
6389        let text = lower(&mut names, &source);
6390        let group: Vec<&str> =
6391            text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
6392        assert_eq!(
6393            group,
6394            ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
6395            "{text}"
6396        );
6397    }
6398
6399    /// Two `long double` values, from two `double` parameters, and the instructions that made
6400    /// them, which every test below this one throws away.
6401    fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
6402        let left = cast(source, block, Opcode::FPExt, args[0], long_double());
6403        let right = cast(source, block, Opcode::FPExt, args[1], long_double());
6404        (left, right)
6405    }
6406
6407    /// The x87 instructions of a function, in order, with everything else dropped.
6408    fn stack_only(text: &str) -> Vec<&str> {
6409        text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
6410    }
6411
6412    /// The two frame slots the last two addresses of a function were taken of, which in a
6413    /// comparison are the two operands in the order they go on the stack.
6414    fn pushed(out: &Lowered) -> Vec<usize> {
6415        let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
6416        taken[taken.len() - 2..].to_vec()
6417    }
6418
6419    #[test]
6420    fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
6421        let f64 = Type::float(rucc_ir::Float::F64);
6422        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6423        let (left, right) = two_long_doubles(&mut source, block, &args);
6424        let sum =
6425            Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
6426        let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
6427        Builder::new(&mut source, block).ret(&[back]);
6428
6429        // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
6430        // four lines are the add: both operands pushed, the instruction that names neither of
6431        // them because they are the top two of a stack, and the answer taken off into its slot.
6432        let text = lower(&mut names, &source);
6433        assert_eq!(
6434            stack_only(&text),
6435            [
6436                "x64.fld_l [%2]",
6437                "x64.fstp_t [%3]",
6438                "x64.fld_l [%4]",
6439                "x64.fstp_t [%5]",
6440                "x64.fld_t [%6]",
6441                "x64.fld_t [%7]",
6442                "x64.fadd_p",
6443                "x64.fstp_t [%8]",
6444                "x64.fld_t [%9]",
6445                "x64.fstp_l [%10]",
6446            ],
6447            "{text}"
6448        );
6449    }
6450
6451    #[test]
6452    fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
6453        let f64 = Type::float(rucc_ir::Float::F64);
6454        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6455        let (left, right) = two_long_doubles(&mut source, block, &args);
6456        let less =
6457            Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
6458        let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
6459        Builder::new(&mut source, block).ret(&[back]);
6460
6461        // The left one goes on first, so it ends up under the right one, and the answer wanted is
6462        // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
6463        // and computes the other one. The `r` says which spelling this is and not which order the
6464        // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
6465        // name is what got this wrong the first time.
6466        let text = lower(&mut names, &source);
6467        assert_eq!(
6468            &stack_only(&text)[4..8],
6469            ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
6470            "{text}"
6471        );
6472    }
6473
6474    #[test]
6475    fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
6476        let f64 = Type::float(rucc_ir::Float::F64);
6477        let (mut names, mut source, block, args) = blank(&[f64]);
6478        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6479        let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
6480        let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
6481        Builder::new(&mut source, block).ret(&[back]);
6482
6483        // `fchs` and not a subtraction from zero, which would give a different answer at a negative
6484        // zero and would signal at a NaN. It does not read the value as a number at all.
6485        let text = lower(&mut names, &source);
6486        assert_eq!(
6487            &stack_only(&text)[2..5],
6488            ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
6489            "{text}"
6490        );
6491    }
6492
6493    #[test]
6494    fn comparing_two_long_doubles_puts_the_left_one_on_top() {
6495        let f64 = Type::float(rucc_ir::Float::F64);
6496        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6497        let (left, right) = two_long_doubles(&mut source, block, &args);
6498        let mut build = Builder::new(&mut source, block);
6499        build.fcmp(FloatPred::Ogt, left, right, Flags::default());
6500        build.ret(&[]);
6501
6502        // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
6503        // operand the predicate is about has to go on last, which is the other way round from the
6504        // arithmetic above. The pop that clears the loser and the byte that reads the flags are
6505        // both inside the one opcode.
6506        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
6507            .expect("every instruction is written");
6508        let slots = pushed(&out);
6509        assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
6510        let text = mir::print_func(&out.func, &names, &REGS);
6511        assert_eq!(
6512            &stack_only(&text)[4..],
6513            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
6514            "{text}"
6515        );
6516    }
6517
6518    #[test]
6519    fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
6520        let f64 = Type::float(rucc_ir::Float::F64);
6521        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6522        let (left, right) = two_long_doubles(&mut source, block, &args);
6523        let mut build = Builder::new(&mut source, block);
6524        build.fcmp(FloatPred::Olt, left, right, Flags::default());
6525        build.ret(&[]);
6526
6527        // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
6528        // the operands the other way round. The same trade the vector rules make, and it has to
6529        // be the same one: a `long double` comparison that picked a different condition from the
6530        // `double` comparison of the same two numbers would be wrong at exactly the unordered
6531        // cases the two conditions differ on.
6532        //
6533        // Which slot each push names is the whole of the difference from the test above, and the
6534        // text does not show it, since an address in a frame is a `lea` with nothing in it until
6535        // `finish` has the numbers. So the slots are what is read here.
6536        let out = func(&source, &mut names, &SYSV, &Elsewhere::default())
6537            .expect("every instruction is written");
6538        let slots = pushed(&out);
6539        assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
6540        let text = mir::print_func(&out.func, &names, &REGS);
6541        assert_eq!(
6542            &stack_only(&text)[4..],
6543            ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
6544            "{text}"
6545        );
6546    }
6547
6548    #[test]
6549    fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
6550        let f64 = Type::float(rucc_ir::Float::F64);
6551        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6552        let (left, right) = two_long_doubles(&mut source, block, &args);
6553        let mut build = Builder::new(&mut source, block);
6554        build.fcmp(FloatPred::Oeq, left, right, Flags::default());
6555        build.ret(&[]);
6556
6557        // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
6558        // second register as well as the one the value is in and ANDs them together. Said here by
6559        // handing it a spare, since an instruction that wrote a register nothing knew about would
6560        // be an instruction the allocator could put a live value in the way of.
6561        let text = lower(&mut names, &source);
6562        assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
6563    }
6564
6565    #[test]
6566    fn a_comparison_that_is_never_asked_is_reported() {
6567        let f64 = Type::float(rucc_ir::Float::F64);
6568        let (mut names, mut source, block, args) = blank(&[f64, f64]);
6569        let (left, right) = two_long_doubles(&mut source, block, &args);
6570        let mut build = Builder::new(&mut source, block);
6571        build.fcmp(FloatPred::False, left, right, Flags::default());
6572        build.ret(&[]);
6573
6574        // Always false is a constant and not a comparison, so there is no condition to pick and
6575        // nothing here folds it into one: an instruction that quietly agreed with it would hide
6576        // that the optimizer left a comparison in that it should have taken out.
6577        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6578            .expect_err("no condition is always false");
6579        assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
6580    }
6581
6582    #[test]
6583    fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
6584        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6585        let mut build = Builder::new(&mut source, block);
6586        // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
6587        let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
6588        build.store(one_and_a_half, args[0], plain(), Flags::default());
6589        build.ret(&[]);
6590
6591        // No x87 instruction at all. A slot holding one of these is the value, so a constant is
6592        // its ten bytes written where the value lives, and whatever reads it does the `fld`.
6593        let text = lower(&mut names, &source);
6594        assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
6595        assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
6596        assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
6597        // The six bytes above the ten are the padding that makes the type sixteen wide, and they
6598        // are unspecified rather than zero, so nothing writes them.
6599        assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
6600    }
6601
6602    #[test]
6603    fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
6604        let (mut names, mut source, block, args) = blank(&[Type::PTR]);
6605        let mut build = Builder::new(&mut source, block);
6606        let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
6607        build.store(minus, args[0], plain(), Flags::default());
6608        build.ret(&[]);
6609
6610        // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
6611        // in a register with is above the signed range of sixteen bits and has to stay there: read
6612        // as a number it would be negative, and it is not a number, it is two bytes.
6613        let text = lower(&mut names, &source);
6614        assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
6615    }
6616
6617    #[test]
6618    fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
6619        let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
6620        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6621        let next = source.create_block();
6622        let param = source.append_param(next, long_double());
6623        Builder::new(&mut source, block).jump(next, &[wide]);
6624        Builder::new(&mut source, next).ret(&[param]);
6625
6626        // What the edge carries is the address of the slot the value is already in, which is an
6627        // ordinary register the allocator has an opinion about. The block on the other side copies
6628        // the sixteen bytes into a slot of its own before anything reads them, so a second edge
6629        // handing over a second address would still leave one place for a reader to look.
6630        let text = lower(&mut names, &source);
6631        let second: Vec<&str> = text
6632            .lines()
6633            .skip_while(|line| !line.starts_with("block1"))
6634            .skip(1)
6635            .take(3)
6636            .map(str::trim)
6637            .collect();
6638        assert_eq!(
6639            second,
6640            ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
6641            "{text}"
6642        );
6643    }
6644
6645    #[test]
6646    fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
6647        let f64 = Type::float(rucc_ir::Float::F64);
6648        let (mut names, mut source, block, args) = blank(&[f64]);
6649        let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
6650        let next = source.create_block();
6651        let params: Vec<Value> =
6652            (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
6653        let carried: Vec<Value> = params.iter().map(|_| wide).collect();
6654        Builder::new(&mut source, block).jump(next, &carried);
6655        Builder::new(&mut source, next).ret(&[params[0]]);
6656
6657        // The copies go through the x87 stack so that every one of them is read before any of them
6658        // is written, which is what makes a block that swaps two of these right. Nine of them do
6659        // not fit on the stack, and copying the ninth before or after the rest is the order that
6660        // could be wrong, so it is refused instead.
6661        let failed = func(&source, &mut names, &SYSV, &Elsewhere::default())
6662            .expect_err("nine do not fit on the stack");
6663        assert_eq!(
6664            failed.to_string(),
6665            "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
6666        );
6667        assert_eq!(failed.inst(), None);
6668    }
6669}