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