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