rucc_codegen/lower.rs
1//! The selector: an IR function becomes a machine IR function.
2//!
3//! Design: `spec/10-backend.md` sections 10.2 and 10.3.
4//!
5//! What the matcher in [`crate::select`] does is answer one question about one term. What this
6//! does is ask it: walk a function, decide which terms are worth asking about, and build machine
7//! instructions out of what comes back. Nothing here decides what an IR term lowers to. That is
8//! in `rules/x86-64.rules` and it is proved before it is used, which is the whole point of the
9//! arrangement and the reason this file is short.
10//!
11//! # What it does with an instruction
12//!
13//! It tries the ways the instruction can be shown to the matcher, in order, and takes the first
14//! that a rule fires on. [`crate::term`] is what a way of showing one is, and the order is the
15//! most specific first: an operand that is a constant is offered as a constant before it is
16//! offered as a register, and an operand computed by an instruction of its own is offered as
17//! that instruction before it is offered as a register. A rule that wants an immediate too wide
18//! for the machine has a guard that turns it down, and the search carries on to the way of
19//! showing it that puts the constant in a register, which is the right answer and is one nobody
20//! had to write down.
21//!
22//! A constant is not lowered where it is written. It is materialized where a register for it is
23//! first wanted, which is what keeps a constant that every use folded into an immediate from
24//! leaving a dead instruction behind, and it also gives the value the shortest live range it
25//! could have. The instruction that materializes it comes from the rule set like everything else.
26//!
27//! # What it does not do yet
28//!
29//! Everything is in the general purpose registers, because every rule in the set is about an
30//! integer, so a call that passes a `double` and a function that returns one are both reported
31//! rather than lowered. So is an argument that travels on the stack, on either side of a call,
32//! and so is a call through an address rather than to a name.
33//!
34//! # A call
35//!
36//! Not a rule, because a rule pattern sees one term and what a call's operands are is whatever
37//! the signature made them. [`crate::abi`] builds one instead, out of the same description of the
38//! convention the arguments come from: the values it passes are reads constrained to the
39//! registers the convention places them in, what comes back is a write constrained to the
40//! register it comes back in, and every other register the callee is free to destroy is a write
41//! of that register and nothing else, which is all the allocator needs to keep a value out of it.
42//!
43//! What that costs the frame is an argument area, and nothing after selection could work out how
44//! big, so the size of the widest call is given back with the function. A function that makes no
45//! call at all is a leaf, and a leaf is the function that may use the red zone.
46//!
47//! # Where a block goes
48//!
49//! On the block, which is what machine IR does with an edge and is why the branches need no more
50//! rule language than the arithmetic did. A rule never names a block, so an unconditional jump
51//! has no rule at all and a conditional branch has one that is about its condition and nothing
52//! else. The arms are copied across after the block is filled, arguments and all, because an
53//! argument that is a constant is materialized where a register for it is first wanted and the
54//! end of the block is where an edge wants it.
55//!
56//! What this leaves behind is a function whose blocks are in the order the IR held them and whose
57//! branches are still branches on a register. Turning one into a `test` and a `jcc` is the block
58//! layout's, since which of the two arms falls through is the layout's answer, and [`crate::split`]
59//! has to run before allocation so that every edge carrying a value has somewhere to put it.
60//!
61//! A store and a return are the two things here that write no register. A store is emitted like
62//! everything else and the only difference is that there is no result to put anywhere, so the
63//! operands the target describes are all reads. A return is the same, and what it is for is its
64//! one operand: the target constrains it to the register the caller reads the value out of, and
65//! the allocator is what gets it there. The instruction that leaves is not chosen here at all,
66//! because the epilogue has to give the frame back first and [`crate::finish`] writes that after
67//! allocation, so a return of nothing is lowered to nothing.
68//!
69//! The entry block is the one block whose parameters are not block parameters here. They are the
70//! function's arguments, they are already somewhere when it starts, and [`crate::abi`] is what
71//! says where. An argument that arrives on the stack is reported rather than read, because where
72//! the stack put it is a distance into a frame and no frame exists until after allocation.
73//!
74//! Blocks are walked in the order the function holds them and a value is expected to be defined
75//! before it is used, which is true of the IR this is given because every pass before it keeps
76//! definitions ahead of uses.
77
78use std::collections::{HashMap, HashSet};
79use std::fmt;
80
81use rucc_base::{Interner, Symbol};
82use rucc_diag::Span;
83use rucc_ir::{
84 Abi, AsmOperand, AsmOperands, AttrSet, Block, Def, Extra, Flags, FloatPred, Func, Inst,
85 Linkage, MemOrder, Opcode, Param, PrefetchHint, RmwOp, Type, Value, Visibility,
86};
87use rucc_mir as mir;
88use rucc_target::template::{template_name, template_reg};
89use rucc_target::{
90 Address, CallRegs, Constraint, OperandDesc, PhysReg, RegClass, Role, VaList, Variadic,
91};
92use rucc_target::{aarch64, x86_64};
93
94use crate::abi::{self, Missing, Refused};
95use crate::coverage::Fired;
96use crate::elsewhere::Elsewhere;
97use crate::frame::{Layout, Local};
98use crate::select::{Match, Piece, Pointer, Reach, Rule, Selector};
99use crate::term::{MAX_ARGS, PLAIN, Plan, Shown, Term, Terms};
100use crate::varargs;
101
102/// The instruction a template's `jmp` to a name outside it becomes.
103///
104/// Not in [`x86_64::FRAME`] with the other opcodes this file names, because a frame never writes
105/// one: the only function it appears in has no prologue and no epilogue for the frame to write
106/// anything into.
107/// See [`x86_64::Step::Away`].
108const AWAY: &str = "jmp_away";
109
110/// How wide an address is on this target, which is the width a cast between a pointer and an
111/// integer has to be at for the cast to be nothing.
112const ADDRESS_BITS: u32 = 64;
113
114/// How much of a register an operand of an `asm` statement fills, which is the width of its type
115/// with two exceptions. A pointer is an address, and a truth value is the byte it is stored in: a
116/// program that writes `sete %0` into a `_Bool` is asking for exactly that byte, which is what tcc's
117/// own test of the width of one checks.
118fn held_bits(ty: Type) -> u32 {
119 if ty.is_ptr() {
120 ADDRESS_BITS
121 } else if ty.bits() == 1 {
122 8
123 } else {
124 ty.bits()
125 }
126}
127
128/// How many bytes a `long double` takes in memory, and what it is aligned to, which are the same
129/// number and are both more than the ten bytes that mean anything.
130///
131/// The psABI's answer rather than a choice here. `sizeof (long double)` is sixteen on this
132/// machine, so an array of them is laid out this way whatever a slot holding one does, and a slot
133/// that agreed with the array is one fewer thing to get wrong.
134const X87_BYTES: u32 = 16;
135
136/// How many values the x87 stack holds at once.
137///
138/// Eight, which is the machine's number rather than a choice here, and it matters in one place:
139/// the parameters of a block are copied through the stack so that they all move at once, and a
140/// block with more of them than this has nowhere to put the ninth.
141const X87_DEPTH: usize = 8;
142
143/// How far into the buffer of a `__builtin_setjmp` each of the four words it writes is.
144///
145/// The first three are gcc's, measured against gcc 16.2.0 on x86-64 at `-O0`: the frame pointer,
146/// the address control comes back to, and the stack pointer, in that order. The fourth is this
147/// compiler's own. gcc has no word for the answer because it writes a second block that sets the
148/// answer to one and is arrived at from the restore, and this writes the answer through memory
149/// instead, for the reason [`Lowering::saves_place`] gives.
150///
151/// None of the four is an interface. The buffer is the program's memory and its five words are
152/// the front end's promise about how much of it there is, but nothing except the matching restore
153/// ever reads a word of it, and a buffer written by one compiler was never going to be one another
154/// compiler could come back through.
155const JUMP_FRAME: i32 = 0;
156
157/// Where the address control comes back to is. See [`JUMP_FRAME`].
158const JUMP_PC: i32 = 8;
159
160/// Where the stack pointer is. See [`JUMP_FRAME`].
161const JUMP_STACK: i32 = 16;
162
163/// Where the address of the word the answer arrives in is. See [`JUMP_FRAME`].
164const JUMP_ANSWER: i32 = 24;
165
166/// How many bytes the word a `__builtin_setjmp` answers with takes in the frame, and what it is
167/// aligned to, which are the same number because it is one machine word.
168const JUMP_WORD: u32 = 8;
169
170/// How many registers the restore needs to hold things in while it puts the frame back.
171///
172/// Four, and every one of them is a register nothing else in the function may be in, which is why
173/// they are counted here rather than asked for one at a time. See [`Lowering::comes_back`].
174const JUMP_REGS: usize = 4;
175
176/// How many bytes the block `__builtin_apply_args` answers takes, which is a word for where the
177/// arguments in memory are, a word of nothing and then the register save area of a variadic
178/// function. See [`Lowering::save_arguments`].
179const APPLY_ARGS: u32 = 192;
180
181/// How far into that block the registers start, which is how far the save area has moved up.
182const APPLY_REGS: u32 = 16;
183
184/// How many bytes the block `__builtin_apply` answers takes, which is two words and two vectors.
185const APPLY_BACK: u32 = 48;
186
187/// How many bytes a value passes through on its way between a register and the x87 stack.
188///
189/// Eight, because the widest thing that crosses is a `double` or a sixty four bit integer, and
190/// nothing crosses at eighty bits: a value that wide is already in the frame and the stack reaches
191/// it where it is.
192const X87_CROSSING: u32 = 8;
193
194/// Where the rounding field of the x87 control word is and what it has to be set to for the unit
195/// to cut towards zero, which is the one rounding C asks for that the unit does not do by default.
196///
197/// Both bits on is truncate. The field is ORed into the word that was already there rather than
198/// written over it, so the precision control and the exception masks somebody else set stay set.
199const X87_TRUNCATE: i64 = 0x0c00;
200
201/// Whether a type is the one this machine has no register for.
202///
203/// Only the eighty bit float is, and that is a fact about x86-64 rather than about floats: every
204/// other scalar the front end produces is in a general purpose register or a vector one, and this
205/// one is on the x87 stack while it is being worked on and in memory the rest of the time. So it
206/// has no place in [`Lowering::class_of`] and no name in [`crate::term`], and every instruction
207/// that touches one is written out by hand in this file.
208fn on_x87(ty: Type) -> bool {
209 ty.is_scalar() && ty.is_float() && ty.bits() == 80
210}
211
212/// Where one operand of an assembly statement is, on each side of the assembly.
213///
214/// Two registers rather than one, because an operand written `+` is a value that arrives and a
215/// value that leaves and those are two values. The machine IR has one definition per register by
216/// construction, so an instruction of the template that reads the operand and writes it has to name
217/// a different register in each place, and what makes the two one register in the end is the
218/// [`Constraint::Reuse`] the instruction's description carries: the allocator reads it, gives both
219/// the same physical register, and copies the incoming value somewhere first when something else is
220/// still using it.
221///
222/// Most operands have one of the two. An input has only a place it is read from and an output
223/// written `=` has only a place it is written to, and asking either of them for the other is an
224/// operand read where the opcode writes or written where it reads, which [`Lowering::placed`]
225/// refuses.
226#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
227struct Place {
228 /// The register the value arrives in, for an operand something reads.
229 read: Option<mir::Reg>,
230 /// The register the value leaves in, for an operand something writes.
231 write: Option<mir::Reg>,
232}
233
234/// Whether that operand of the statement is one the assembly may read, and so where a read of it
235/// gets its value from.
236///
237/// [`bound`] asks this question of an operand a constraint letter named and this asks it of one the
238/// template numbered, which is the same question twice because a two-address instruction reaches
239/// its first source both ways. `mulq %3` reaches `rax` by the letter on the output and libgmp says
240/// what is in it with `"%0"` on an input. `addq %5,%q1` reaches its first source by numbering the
241/// output, and libgmp says what is in it with `"0"` on an input in the same way.
242///
243/// So an output written `=` has no value of its own and is still readable when an input is tied to
244/// it, and the value the read wants is that input's. An output written `+` carries its own value
245/// and answers with that. An output nothing is tied to answers `None`, which is a program that told
246/// the compiler the assembly only writes the operand while the instruction reads it before it
247/// writes it, and is refused where it is asked.
248fn read_as(list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
249 let operand = list.get(index)?;
250 if operand.value.is_some() {
251 return operand.value;
252 }
253 operand.result?;
254 list.iter().find(|entry| entry.tied == Some(index)).and_then(|entry| entry.value)
255}
256
257/// Which of an assembly statement's operands is in that register, for an instruction that reaches
258/// the register without its text saying so.
259///
260/// The constraint is what says so, and it is the only thing in such a statement that could:
261/// `"=a"` is an output in `rax`, `"c"` is an input in `rcx`, an operand that is a local register
262/// variable is in the register its declaration named, and a register nothing names is a register
263/// nobody has said anything about. So a write looks among the outputs and a read among the inputs,
264/// and an output written `+` answers for either, since it is read before it is written. See
265/// [`pinned`], which is the one question asked of both ways of saying it.
266///
267/// The other way a read of such a register is said is a matching constraint. `"=a"` on an output
268/// and `"0"` on an input is the program saying that one register holds the input on the way in and
269/// the output on the way out, and it is how a statement fills a register the instruction reads and
270/// writes without writing the register down twice. The letter is on the output, which has no value
271/// to read, and the value is on the input, which has no letter, and the answer is the output: its
272/// place is read out of the register the input arrived in, and in a template with a loop in it the
273/// place moves on to wherever the last write left it, which is what a read on the next time round
274/// wants. tcc steps a pointer along a string with `lodsb` and `"=&S"` tied to `"0"`, and a read of
275/// the input would start the string again every time round.
276///
277/// And a read of a register an output alone is in is a read of that output, the same as a read of
278/// an output the template numbered. tcc copies a string with `lodsb` and `stosb` and `"=&a"` on an
279/// output nothing is tied to, and what `stosb` stores is what `lodsb` loaded one line up, which is
280/// the output as the template left it rather than anything the statement handed in.
281///
282/// `None` is a register the instruction uses and the statement put nothing in, which is the usual
283/// answer rather than an unusual one. `cpuid` writes four registers and a program that wanted one
284/// of them names one. See [`Lowering::spare`], which is where that one goes.
285fn bound(list: &[AsmOperand<'_>], reg: PhysReg, role: Role) -> Option<usize> {
286 let output =
287 list.iter().position(|operand| operand.result.is_some() && pinned(operand) == Some(reg));
288 if role.is_def() {
289 return output;
290 }
291 // The output first when something is in it on the way in, which is what `+` and a matching
292 // constraint both say, since its place is where a write earlier in the template left it and
293 // the read wants that. See [`read_as`] for what it holds before anything wrote it.
294 let arrives = |at: usize| read_as(list, at).is_some();
295 if let Some(at) = output.filter(|&at| arrives(at)) {
296 return Some(at);
297 }
298 let named = list.iter().position(|operand| {
299 operand.result.is_none() && operand.value.is_some() && pinned(operand) == Some(reg)
300 });
301 named.or(output)
302}
303
304/// The register one of an assembly statement's operands is in, whichever of the two ways said it.
305///
306/// A constraint letter is one way and is the only way a program can say one of the six registers
307/// that have a letter. A local register variable is the other, and it is the only way to say any
308/// of the rest: there is no letter for `r12`, which is the whole reason the extension exists, so
309/// the declaration says it and the front end wrote the name into the constraint. The name is read
310/// against this machine's table here, the same place the letter is read against it, and a name the
311/// machine has not got answers nothing, which leaves the operand where an operand nobody placed
312/// goes.
313///
314/// The sigil gcc allows in front of a name is taken off here, because what a name is written with
315/// is syntax and which register it means is this question.
316fn pinned(operand: &AsmOperand<'_>) -> Option<PhysReg> {
317 match operand.named {
318 Some(name) => {
319 let (reg, _) = x86_64::gpr_named(name.strip_prefix('%').unwrap_or(name))?;
320 Some(reg)
321 }
322 None => operand.fixed.and_then(x86_64::gpr_letter),
323 }
324}
325
326/// Whether a constraint says nothing but what it says on every machine.
327///
328/// [`AsmOperands::read`] gives the x86 meaning to every letter it knows, and most of the letters
329/// mean something else on AArch64: `Q` is an address in one register there rather than one of four
330/// registers, and `a` to `d` name nothing. So an AArch64 statement is taken only with the letters
331/// the two agree on, which are a register, a constant, memory, the immediate ranges and a matching
332/// number, and anything else is refused rather than read as x86. `w` and `Q` are the exceptions.
333/// `w` is a register on both, and which file it is in is decided by the caller with
334/// [`vector_letter`]. `Q` is read as `m` by the caller before the list is read. A
335/// register the front end named in braces is read against AArch64's own names, so what is inside
336/// them is not a letter.
337fn shared_letters(constraint: &str) -> bool {
338 let mut inside = false;
339 constraint.chars().all(|c| match c {
340 '{' => {
341 inside = true;
342 true
343 }
344 '}' => {
345 inside = false;
346 true
347 }
348 _ if inside => true,
349 _ => matches!(
350 c,
351 '=' | '+' | '&' | '%' | 'r' | 'w' | 'Q' | 'm' | 'o' | 'V' | 'g' | 'X' | 'i' | 'n'
352 | 'p' | 'I'..='N' | '0'..='9'
353 ),
354 })
355}
356
357/// A constraint list with every letter outside braces put through `swap`, and what is inside them,
358/// which is a register's name rather than letters, left alone.
359fn letters_outside(constraints: &str, swap: impl Fn(char) -> char) -> String {
360 let mut inside = false;
361 constraints
362 .chars()
363 .map(|c| {
364 match c {
365 '{' => inside = true,
366 '}' => inside = false,
367 _ if !inside => return swap(c),
368 _ => {}
369 }
370 c
371 })
372 .collect()
373}
374
375/// Whether an AArch64 constraint asks for a floating point or vector register, which is what `w`
376/// means there. A register named in braces is not a letter, so a `w` inside one is not read.
377fn vector_letter(constraint: &str) -> bool {
378 let mut inside = false;
379 constraint.chars().any(|c| {
380 match c {
381 '{' => inside = true,
382 '}' => inside = false,
383 _ => {}
384 }
385 !inside && c == 'w'
386 })
387}
388
389/// Whether a line of a template names, by number, an operand `wanted` says yes to.
390///
391/// `%%` is a percent sign rather than an operand, and a modifier letter may stand between the sign
392/// and the number.
393fn names_one(line: &str, wanted: impl Fn(usize) -> bool) -> bool {
394 let mut rest = line;
395 while let Some(at) = rest.find('%') {
396 let after = &rest[at + 1..];
397 if let Some(escaped) = after.strip_prefix('%') {
398 rest = escaped;
399 continue;
400 }
401 let after = after.strip_prefix(|c: char| c.is_ascii_alphabetic()).unwrap_or(after);
402 let digits = after.len() - after.trim_start_matches(|c: char| c.is_ascii_digit()).len();
403 if after[..digits].parse().is_ok_and(&wanted) {
404 return true;
405 }
406 rest = &after[digits..];
407 }
408 false
409}
410
411/// Why a function could not be lowered.
412///
413/// One reason and then nothing. A function with no rule for something in it is a function this
414/// cannot finish, and the second thing it could not lower is not news.
415#[derive(Debug, Clone, PartialEq, Eq)]
416pub enum Unsupported {
417 /// An instruction no rule fires on.
418 Inst {
419 /// The instruction that stopped it.
420 inst: Inst,
421 /// What the rule file would call it, or nothing if the rule language has no name for it
422 /// at all, which is what an instruction at a width nothing is written about looks like.
423 term: Option<&'static str>,
424 /// The opcode, which is what gets named when the rule language has no word for it.
425 ///
426 /// An opcode the rule language has no word for is exactly the opcode no rule lowers, so
427 /// without this the message would be empty in every case where somebody needs it.
428 opcode: Opcode,
429 /// What it produces, or nothing for an instruction that is only an effect.
430 ty: Option<Type>,
431 },
432 /// A parameter that does not arrive somewhere this can bring it in from.
433 ///
434 /// Not an instruction, which is why it is a separate arm: it is a fact about the signature
435 /// and there is nothing in the body of the function to point at.
436 Argument {
437 /// Its position in the signature.
438 index: usize,
439 /// What is wrong with where it arrives.
440 missing: Missing,
441 },
442 /// A call that passes or gives back a value this cannot put where the convention wants it.
443 Call {
444 /// The call.
445 inst: Inst,
446 /// Which value, and what is wrong with where it travels.
447 refused: Refused,
448 },
449 /// A `return` this cannot put where the convention wants it.
450 ///
451 /// A separate arm from [`Unsupported::Inst`] because it is not an instruction no rule fires
452 /// on. A return of more than one value is built from the convention rather than matched, the
453 /// same way a call is, so what goes wrong with one is what goes wrong with a call and not the
454 /// absence of a rule.
455 Returned {
456 /// The `return`.
457 inst: Inst,
458 /// What is wrong with where one of the values travels.
459 missing: Missing,
460 },
461 /// A stack slot the frame cannot give the bytes it asked for.
462 ///
463 /// Not an instruction no rule covers. An `alloca` is built here rather than matched, so what
464 /// goes wrong with one is what the frame can and cannot hold rather than what the rules spell.
465 Dynamic {
466 /// The `alloca`.
467 inst: Inst,
468 /// What the frame could not do about it.
469 growing: Growing,
470 },
471 /// More parameters of a type that travels on the x87 stack than the stack is deep.
472 ///
473 /// Not an instruction either, for the reason a function's parameter is not one: it is a fact
474 /// about the block and there is nothing in the block to point at. What crosses an edge for one
475 /// of these is the address of where the value is, and the block copies the bytes into a slot
476 /// of its own, all of them through the stack at once so that a block carrying two of them
477 /// swapped is copied in an order that is right. Eight is as many as the stack holds, and a
478 /// ninth would have to be copied before or after the rest, which is the order that could be
479 /// wrong.
480 Phi {
481 /// Which block it arrives at.
482 block: Block,
483 /// How many of them arrive there, which is the whole of what is wrong.
484 count: usize,
485 /// What they are.
486 ty: Type,
487 },
488 /// An `asm` statement this cannot build.
489 ///
490 /// Not an instruction no rule fires on, for the reason a call is not one: what it stands for is
491 /// whatever its template says, and no pattern over terms can read a string.
492 Assembly {
493 /// The `inline_asm`.
494 inst: Inst,
495 /// What about it is not built here yet.
496 refused: Written,
497 },
498 /// A `register long x asm ("...")` naming something this machine has not got.
499 ///
500 /// Not an instruction no rule fires on. There is a rule's worth of instruction here and what
501 /// is wrong is the string beside it, which is a name rather than a term, so the message says
502 /// the name. Which names a machine has is the machine's own question and this is where it is
503 /// asked, at the table a clobber list is read against.
504 Register {
505 /// The `register_value`.
506 inst: Inst,
507 /// The name the program wrote, as it wrote it.
508 name: String,
509 },
510 /// A naked function whose frame is not empty.
511 ///
512 /// Not an instruction no rule fires on, and there is nothing in the body to point at: the
513 /// function asked for no prologue and then wanted bytes only a prologue takes. Refused rather
514 /// than given the bytes anyway, because an offset into a frame nothing set up reaches into
515 /// whatever the caller left below its own stack pointer, which is wrong code that assembles.
516 /// See [`crate::frame::Layout::naked`].
517 Naked {
518 /// How many bytes it wanted, which is the whole of what is wrong.
519 bytes: u32,
520 },
521 /// Something the x86-64 lowering writes by hand and nothing has written for this machine yet.
522 ///
523 /// Refused rather than written with the x86 instructions, which is what the walk would do
524 /// otherwise, since these are the places it names them itself.
525 Unported {
526 /// The instruction, or nothing for the one that is about a signature.
527 inst: Option<Inst>,
528 /// Which of them.
529 what: Unported,
530 },
531}
532
533/// What [`Unsupported::Unported`] is about.
534#[derive(Debug, Clone, Copy, PartialEq, Eq)]
535pub enum Unported {
536 /// The thread pointer on Apple's platforms, which keep it somewhere other than Linux does.
537 Thread,
538}
539
540impl Unported {
541 /// The whole message, since there is nothing to put in front of it.
542 #[must_use]
543 pub fn why(self) -> &'static str {
544 match self {
545 Unported::Thread => "the thread pointer is not written for this platform yet",
546 }
547 }
548}
549
550/// What about an `asm` statement is not built yet.
551#[derive(Debug, Clone, Copy, PartialEq, Eq)]
552pub enum Written {
553 /// A template with instructions in it.
554 Template,
555 /// An `asm goto`, whose labels make the statement a terminator.
556 Goto,
557 /// An operand this cannot put where the constraint says it goes.
558 Operand,
559 /// A clobber list naming something this has no register for.
560 Clobber,
561 /// A `jmp` out of the function in a function that has an epilogue behind it.
562 Away,
563}
564
565impl Written {
566 /// The rest of the sentence that starts with the statement.
567 #[must_use]
568 pub fn why(self) -> &'static str {
569 match self {
570 // The template is the assembler's to read and there is no assembler here yet, so a
571 // template with anything in it is a string nothing can turn into bytes. An empty one is
572 // no instructions, and no instructions is something this can write.
573 Written::Template => "has instructions in its template, which nothing here assembles",
574 Written::Goto => "jumps to a label, which nothing here builds an edge for",
575 Written::Operand => "has an operand this cannot place",
576 Written::Clobber => "says it destroys a register this has no name for",
577 Written::Away => {
578 "jumps out of the function, which only a function that is `naked` may do, since \
579 anywhere else there is an epilogue behind it to give the frame back"
580 }
581 }
582 }
583}
584
585/// What the frame could not do about a stack slot.
586#[derive(Debug, Clone, Copy, PartialEq, Eq)]
587pub enum Growing {
588 /// An object of a size the number a frame counts bytes in does not reach.
589 Huge,
590 /// A variable length array wanting more alignment than a call leaves the stack pointer with.
591 ///
592 /// Rounding the stack pointer down again after the bytes have been taken would put it
593 /// somewhere no constant reaches the rest of the frame from, so a frame like this needs a
594 /// second base register held for the whole of the function. Nothing here holds one.
595 ///
596 /// [`crate::expand::rounds`] takes the array away before this sees it, by asking for the
597 /// alignment in extra bytes and handing out an address inside them, so what is left of this
598 /// is IR that arrived without going through that pass and the fixed local in
599 /// [`crate::pipeline`] that wants the same thing from the other side.
600 Aligned,
601 /// A variable length array in a function written without a prologue.
602 ///
603 /// A frame that grows is reached from a frame pointer, and establishing one is the first two
604 /// instructions of a prologue that `__attribute__((naked))` asked there be none of. See
605 /// [`crate::frame::Layout::naked`].
606 Naked,
607}
608
609impl Growing {
610 /// The rest of the sentence that starts with the slot.
611 #[must_use]
612 pub fn why(self) -> &'static str {
613 match self {
614 Growing::Huge => "is more bytes than a frame counts",
615 Growing::Aligned => {
616 "wants more alignment than the stack pointer is left on, which needs a base \
617 register nothing here keeps"
618 }
619 Growing::Naked => {
620 "is in a function that is `naked`, which has no prologue to point a frame pointer \
621 at it with"
622 }
623 }
624 }
625}
626
627impl Unsupported {
628 /// The instruction it is about, or nothing for the one arm that is about a signature.
629 ///
630 /// What a caller wants this for is the span. The function knows where every instruction in
631 /// it came from, so a caller holding both can point a message at the line somebody wrote
632 /// rather than at the file as a whole, and nothing here has to carry a span of its own.
633 pub fn inst(&self) -> Option<Inst> {
634 match *self {
635 Unsupported::Inst { inst, .. }
636 | Unsupported::Call { inst, .. }
637 | Unsupported::Returned { inst, .. }
638 | Unsupported::Dynamic { inst, .. }
639 | Unsupported::Assembly { inst, .. }
640 | Unsupported::Register { inst, .. } => Some(inst),
641 Unsupported::Unported { inst, .. } => inst,
642 Unsupported::Argument { .. } | Unsupported::Phi { .. } | Unsupported::Naked { .. } => {
643 None
644 }
645 }
646 }
647}
648
649impl fmt::Display for Unsupported {
650 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
651 match *self {
652 Unsupported::Inst { term: Some(term), .. } => write!(f, "no rule lowers `{term}`"),
653 Unsupported::Inst { term: None, opcode, ty: Some(ty), .. } => {
654 write!(f, "no rule lowers a `{opcode}` producing a `{ty}`")
655 }
656 Unsupported::Inst { term: None, opcode, ty: None, .. } => {
657 write!(f, "no rule lowers a `{opcode}`")
658 }
659 Unsupported::Argument { index, missing } => {
660 write!(f, "parameter {index} {}", missing.why())
661 }
662 Unsupported::Call { refused: Refused { argument: Some(index), missing }, .. } => {
663 write!(f, "argument {index} of this call {}", missing.why())
664 }
665 Unsupported::Call { refused: Refused { argument: None, missing }, .. } => {
666 write!(f, "what this call gives back {}", missing.why())
667 }
668 Unsupported::Returned { missing, .. } => {
669 write!(f, "what this function gives back {}", missing.why())
670 }
671 Unsupported::Dynamic { growing, .. } => {
672 write!(f, "this local {}", growing.why())
673 }
674 Unsupported::Phi { block, count, ty } => {
675 let block = block.index();
676 write!(
677 f,
678 "block{block} takes {count} parameters of type `{ty}` and only {X87_DEPTH} can cross an edge at once"
679 )
680 }
681 Unsupported::Assembly { refused, .. } => write!(f, "this `asm` {}", refused.why()),
682 Unsupported::Unported { what, .. } => f.write_str(what.why()),
683 Unsupported::Register { ref name, .. } => {
684 write!(
685 f,
686 "this object is kept in `{name}`, which is not a register this machine has"
687 )
688 }
689 Unsupported::Naked { bytes } => write!(
690 f,
691 "this function is `naked` and wants {bytes} bytes of frame, which there is no prologue to take"
692 ),
693 }
694 }
695}
696
697impl std::error::Error for Unsupported {}
698
699/// A lowered function, and what the frame needs that the machine IR does not hold.
700#[derive(Debug)]
701pub struct Lowered {
702 /// The function, in machine instructions.
703 pub func: mir::Func,
704 /// What it wants its stack to look like, which is separate from the function so that the two
705 /// can be read and written at the same time.
706 pub stack: Stack,
707 /// Which rules of the table lowered it, which is what `-Zrule-coverage` asks for and what
708 /// `crate::coverage` writes down.
709 pub fired: Fired,
710 /// Which machine IR block each IR block became, indexed by the IR block's own index, and
711 /// nothing for a block the walk never reached.
712 ///
713 /// Here because it is the only place the correspondence exists. Selection makes one block per
714 /// block, in the same order and with the arms in the same order, so anything the IR knows
715 /// about a block can be carried down through this and nothing else, and
716 /// [`crate::weights::carry`] is what does.
717 pub blocks: Vec<Option<mir::Block>>,
718}
719
720/// What a function's stack has to hold, as far as selection is able to say.
721///
722/// All of it is answered here because selection is where a call is built and where an `alloca`
723/// is read, and nothing after it could tell what either of them needed.
724#[derive(Debug, Default)]
725pub struct Stack {
726 /// How many bytes the widest call in the function needs below the stack pointer for the
727 /// arguments it passes there, or `None` for a function that makes no call at all.
728 ///
729 /// `None` is a leaf, which is the function that may use the red zone and the one whose stack
730 /// pointer does not have to be left aligned for anybody.
731 pub calls: Option<u32>,
732 /// The memory the function asked for itself, one entry for every `alloca` in it, in the order
733 /// the walk reached them.
734 pub locals: Vec<Local>,
735 /// Which instruction computes the address of which of those locals.
736 ///
737 /// An address in the frame is a distance from the stack pointer, and there is no frame until
738 /// after allocation, so the instruction is written here with nothing in its displacement and
739 /// [`crate::finish`] writes the number in once [`crate::frame::Frame`] knows it.
740 pub addresses: Vec<(mir::Inst, usize)>,
741 /// Which of those locals is which declaration in the source, for the ones the program declared.
742 ///
743 /// The number is the one the IR function carries and means nothing here. What it is for is the
744 /// debugging information, which has to say where a named local ended up and cannot ask the
745 /// frame directly: the frame knows a local by the order the `alloca` for it was lowered in and
746 /// by nothing else.
747 ///
748 /// Shorter than the list above rather than the same length, because most of what a function
749 /// keeps in its frame is memory an expression wanted somewhere to put.
750 pub declared: Vec<(usize, u32)>,
751 /// Which instruction computes the address of a piece of memory whose size the function works
752 /// out while it runs, which is what a variable length array is.
753 ///
754 /// Waiting on [`crate::finish`] for a different number from the one the addresses above are:
755 /// the bytes were taken off the stack pointer by the instruction in front of this one, so where
756 /// they start is however much of the bottom of the frame belongs to the arguments of a call,
757 /// and that is not known until the frame is.
758 pub dynamic: Vec<mir::Inst>,
759 /// Which instruction takes those bytes off the stack pointer, one for every one of them, in the
760 /// order the walk reached them.
761 ///
762 /// Read by [`crate::finish`] on a command line that asked for the stack to be touched a page at
763 /// a time, which is the one thing that has to find these again: the bytes are in a register by
764 /// then, so the walk down to them is a loop, and a loop is written around an instruction rather
765 /// than in front of a block. Nothing else looks at them, because everything else about a frame
766 /// that grows is answered by the address the instruction below this one computes.
767 pub grown: Vec<mir::Inst>,
768 /// Where the function first moves the stack pointer while it runs, if it does at all.
769 ///
770 /// Two things are read off this. One is whether at all, which is what [`crate::frame::Layout`]
771 /// wants, because a frame that moves its stack pointer has a different shape from one that does
772 /// not and the layout is built before the instructions are looked at again. See `Growing` in
773 /// [`crate::frame`]. The other is where, so that a caller that cannot accept such a frame has
774 /// somewhere to point when it says so.
775 pub grown_at: Option<Inst>,
776 /// Which instruction reads which of the arguments the caller passed on the stack, as how far up
777 /// the caller's argument area it reads.
778 ///
779 /// Waiting on [`crate::finish`] for the same reason the addresses above are, and on one thing
780 /// more: where the caller's argument area is from inside this function depends on whether the
781 /// prologue had to force the stack pointer's alignment, so which register the load reads
782 /// through is not settled here either.
783 pub arguments: Vec<(mir::Inst, u32)>,
784 /// Whether the function asked where its own frame is, which is what `__builtin_frame_address`
785 /// and `__builtin_return_address` both start from.
786 ///
787 /// A function like that keeps a frame pointer whatever the flags say, because the register is
788 /// the answer to the first of them and the start of the walk for every depth above zero. There
789 /// is no other way to reach it: the distance from the stack pointer to the frame is a number
790 /// the layout works out, and what a walk up the chain needs is the link the prologue saved.
791 pub walks_frames: bool,
792 /// Whether the function saved a place for a `__builtin_longjmp` to come back to, which is what
793 /// `__builtin_setjmp` does.
794 ///
795 /// A function like that keeps a frame pointer whatever the flags say as well, and for a reason
796 /// of the same shape: the two registers the restore puts back are the frame pointer and the
797 /// stack pointer, and a frame that did not keep the first of them has nothing in it saying
798 /// where the caller's frame is for the epilogue to find after control has come back.
799 pub saves_place: bool,
800}
801
802impl Stack {
803 /// The layout given, with the three fields only the lowering knows the answer to filled in.
804 ///
805 /// Everything else in a layout comes from the flags the function is compiled under or from the
806 /// allocation, so this takes one and returns it rather than building one.
807 ///
808 /// A function that saved a place is not a leaf whatever it called. What a leaf buys is the red
809 /// zone, which is the words below the stack pointer nothing else may write, and a function
810 /// control comes back into from a `__builtin_longjmp` has already had something else running
811 /// down there: whatever it called and whatever that called, or a signal handler on the same
812 /// stack. Every one of those has written over the red zone by the time control arrives, so a
813 /// value this function left there would not be there any more.
814 #[must_use]
815 pub fn layout<'a>(&'a self, base: Layout<'a>) -> Layout<'a> {
816 Layout {
817 leaf: self.calls.is_none() && !self.saves_place,
818 outgoing: self.calls.unwrap_or(0),
819 locals: &self.locals,
820 grows: self.grown_at.is_some(),
821 ..base
822 }
823 }
824}
825
826/// The machine IR for that function, for the machine the selector describes.
827///
828/// # Errors
829///
830/// The first instruction no rule fires on, which today is anything at a width the rule set is not
831/// written at, a parameter that does not arrive in a register this can read, or a call that
832/// passes something this cannot put where the convention wants it.
833pub fn func(
834 source: &Func,
835 names: &mut Interner,
836 selector: &'static Selector,
837 conv: &'static CallRegs,
838 elsewhere: &Elsewhere,
839) -> Result<Lowered, Unsupported> {
840 Lowering::new(source, names, selector, conv, elsewhere).run()
841}
842
843/// What the matcher settled on for one block, indexed the way the block's instructions are.
844struct Decided {
845 /// What each instruction matched, and nothing for one that matched no rule or was folded
846 /// into a later one.
847 found: Vec<Option<Match<Term>>>,
848 /// How each instruction showed its operands to the matcher, which is what says what it took.
849 plans: Vec<Option<Plan>>,
850 /// The instructions some other instruction took, which are the ones with nothing to write.
851 folded: Vec<Inst>,
852}
853
854/// The instruction in front of an assignment that starts a declaration on a value, and the first
855/// machine instruction after it once the block is filled.
856type Mark = (Option<Inst>, Option<mir::Inst>);
857
858/// One function being lowered.
859struct Lowering<'a> {
860 source: &'a Func,
861 names: &'a mut Interner,
862 out: mir::Func,
863 /// The machine register each IR value is in, once it has one.
864 regs: Vec<Option<mir::Reg>>,
865 /// For a constant that has been written into a register, the block it was written into,
866 /// which is the only block that register is any good in.
867 written: Vec<Option<mir::Block>>,
868 /// How many times each IR value is read, which is what says whether an instruction may be
869 /// folded into the one that reads it.
870 uses: Vec<u32>,
871 /// The block being filled.
872 at: Option<mir::Block>,
873 /// The machine IR block each IR block became.
874 blocks: Vec<Option<mir::Block>>,
875 /// The class an address is in, which is the general purpose one and is not a question: every
876 /// register an addressing mode names holds part of an address, and there is no machine here
877 /// that computes an address anywhere but in this file. Which class a *value* is in is
878 /// [`Lowering::class_of`], and it is a question, because a float is in the other one.
879 gpr: RegClass,
880 /// The machine this selects for.
881 selector: &'static Selector,
882 /// Where the convention this function is compiled for puts things, which is read for the
883 /// arguments and for the calls.
884 conv: &'static CallRegs,
885 /// Which names this function may not work an address out for itself, which is a fact about the
886 /// module and so is worked out before any of this and handed in.
887 elsewhere: &'a Elsewhere,
888 /// What the function wants its stack to look like, filled in as the walk finds out.
889 stack: Stack,
890 /// What a `va_start` in this function has to write, or nothing for a function that takes no
891 /// arguments its signature does not name.
892 ///
893 /// Worked out once, when the entry block binds the parameters, because every number in it is
894 /// about where those parameters left the walk over the argument registers and there is nowhere
895 /// else that knows.
896 varargs: Option<Varargs>,
897 /// Which of the function's stack objects each eighty bit value lives in, once it has asked
898 /// for one.
899 ///
900 /// One slot per value and it is never given back, which is what makes an eighty bit value
901 /// behave like every other one: it is written once and read wherever it is read, and no two
902 /// of them share a slot the way two of them would share a register. What is in a register is
903 /// the address, and that is worked out again at every use rather than kept, so nothing here
904 /// holds a general purpose register open across a whole function.
905 slots: Vec<Option<usize>>,
906 /// The eight bytes a value passes through between a register and the x87 stack, once
907 /// something has wanted them.
908 ///
909 /// One for the whole function, because every group that uses it is a handful of instructions
910 /// with nothing in between: the bytes are written, read straight back and never looked at
911 /// again, so a second slot would be a second slot holding the same nothing.
912 crossing: Option<usize>,
913 /// The four bytes the control word is saved in and the changed copy written to, once
914 /// something has wanted them.
915 ///
916 /// One for the whole function for the reason above, and four rather than two because it is
917 /// two words: the one the unit had and the one with the rounding field turned to truncate.
918 control: Option<usize>,
919 /// The word a `__builtin_setjmp` in this function answers with, once one has asked for it.
920 ///
921 /// One for the whole function however many saves there are in it, because the word is written
922 /// and read back with nothing in between: the save writes a zero into it and the instruction
923 /// straight after reads it, and the only other thing that ever writes it is a restore arriving
924 /// between those two. Two saves sharing it is two pairs each doing that, and neither can be
925 /// inside the other.
926 answer: Option<usize>,
927 /// The block `__builtin_apply_args` answers the address of, or nothing in a function that holds
928 /// none.
929 ///
930 /// Written once, in the prologue, because what it holds is every argument register as it was
931 /// on the way in, and by the time the walk reaches the call the registers hold whatever the
932 /// function has done since. Every `__builtin_apply_args` in the function answers the same one.
933 applied: Option<usize>,
934 /// Which rules have fired so far.
935 fired: Fired,
936 /// Where each assignment that starts a declaration on a value part of the way through is, by
937 /// the IR block it is in and the instruction in front of it, and which machine instruction
938 /// is the first one after it once the block has been filled. See
939 /// [`rucc_ir::Func::declare_value_from`].
940 marks: HashMap<Block, Vec<Mark>>,
941}
942
943/// What a `va_start` in a variadic function writes into the list it is given.
944///
945/// Two shapes, because two conventions describe a list two ways, and [`crate::varargs`] is where
946/// both are written down. Neither is a set of numbers on its own: where the save area is and where
947/// the caller's argument area is are distances into a frame that does not exist until after
948/// allocation, so each is a `lea` [`crate::finish`] fills in.
949#[derive(Debug, Clone, Copy, PartialEq, Eq)]
950enum Varargs {
951 /// The four field list, whose two offsets are settled here and whose two addresses are not.
952 Fields {
953 /// Which of the function's stack objects is the register save area.
954 save: usize,
955 /// How far up the caller's argument area the first argument the signature does not name is,
956 /// which is the whole of that area the named ones did not take.
957 incoming: u32,
958 /// What `gp_offset` starts at, which is past the general purpose registers the named
959 /// arguments took.
960 integers: u32,
961 /// What `fp_offset` starts at, which is past the vector ones.
962 floats: u32,
963 },
964 /// The AAPCS64 list, whose two offsets count up to zero from the top of each half of the save
965 /// area. The two tops are addresses in the frame and so is the first field, like the SysV list.
966 Aapcs {
967 /// Which of the function's stack objects is the register save area.
968 save: usize,
969 /// How far up the caller's argument area the first argument the signature does not name is.
970 incoming: u32,
971 /// Where the general purpose half of the save area ends.
972 integers_end: u32,
973 /// Where the vector half ends, which is the end of the area.
974 floats_end: u32,
975 /// What `__gr_offs` starts at, which is minus the general purpose half the named arguments
976 /// did not take.
977 integers: i32,
978 /// What `__vr_offs` starts at.
979 floats: i32,
980 },
981 /// The list that is a pointer, which is the one address and nothing else.
982 Pointer {
983 /// How far up the caller's argument area the first argument the signature does not name is,
984 /// which on this convention is the word belonging to the position the named ones stopped
985 /// at.
986 incoming: u32,
987 },
988}
989
990/// How far a function's name reaches, narrowed from the linkage the IR gave it.
991///
992/// The IR has five and an object file says three, and the two the linker cannot tell apart are
993/// the two weak ones: which of them a symbol had is a fact the optimizer reads and the linker has
994/// no way to record. A function is never `Common`, since that is what a tentative definition of an
995/// object is and there is no tentative definition of a function, and it is written here rather
996/// than left out so that a linkage added later has to come past this.
997const fn binding(linkage: Linkage) -> mir::Binding {
998 match linkage {
999 Linkage::Internal => mir::Binding::Local,
1000 Linkage::Weak | Linkage::LinkOnce => mir::Binding::Weak,
1001 Linkage::External | Linkage::Common => mir::Binding::Global,
1002 }
1003}
1004
1005/// How far a function's name reaches outside a shared library, carried across unchanged.
1006///
1007/// Nothing is narrowed here the way [`binding`] narrows the linkage, because ELF records all
1008/// three of these and the two enumerations are the same three answers written twice: once in a
1009/// crate that is not allowed to know what an object file is and once in one that is.
1010const fn visibility(visibility: Visibility) -> mir::Visibility {
1011 match visibility {
1012 Visibility::Default => mir::Visibility::Default,
1013 Visibility::Hidden => mir::Visibility::Hidden,
1014 Visibility::Protected => mir::Visibility::Protected,
1015 }
1016}
1017
1018impl<'a> Lowering<'a> {
1019 fn new(
1020 source: &'a Func,
1021 names: &'a mut Interner,
1022 selector: &'static Selector,
1023 conv: &'static CallRegs,
1024 elsewhere: &'a Elsewhere,
1025 ) -> Self {
1026 let counts = source.counts();
1027 let name = source.name;
1028 let mut uses = vec![0; counts.values];
1029 for block in source.blocks() {
1030 for inst in source.insts(block) {
1031 for &arg in &source[source[inst].args] {
1032 uses[arg.index()] += 1;
1033 }
1034 for call in source.successors(inst) {
1035 for &arg in &source[call.args] {
1036 uses[arg.index()] += 1;
1037 }
1038 }
1039 }
1040 }
1041 let mut out = mir::Func::new(name);
1042 out.align = source.align;
1043 // Carried rather than worked out here, because where a function was declared is a fact
1044 // about the source and this is a long way past it. What wants it is the line table.
1045 out.declared = source.declared;
1046 out.binding = binding(source.linkage);
1047 out.visibility = visibility(source.visibility);
1048 Self {
1049 source,
1050 names,
1051 out,
1052 regs: vec![None; counts.values],
1053 written: vec![None; counts.values],
1054 blocks: vec![None; counts.blocks],
1055 uses,
1056 at: None,
1057 gpr: selector.gpr,
1058 selector,
1059 conv,
1060 elsewhere,
1061 stack: Stack::default(),
1062 varargs: None,
1063 slots: vec![None; counts.values],
1064 crossing: None,
1065 control: None,
1066 answer: None,
1067 applied: None,
1068 fired: Fired::new(),
1069 marks: HashMap::new(),
1070 }
1071 }
1072
1073 fn run(mut self) -> Result<Lowered, Unsupported> {
1074 for value in self.source.values() {
1075 for start in self.source.value_starts(value) {
1076 let Some((block, after)) = self.source.start_place(start) else { continue };
1077 let marks = self.marks.entry(block).or_default();
1078 if !marks.iter().any(|&(have, _)| have == after) {
1079 marks.push((after, None));
1080 }
1081 }
1082 }
1083 // Every block before any of them is filled, because a block that jumps forward has to
1084 // name the block it jumps to and a machine IR block is named by a handle rather than by
1085 // the IR block it came from.
1086 for block in self.source.blocks() {
1087 let out = self.out.create_block();
1088 self.blocks[block.index()] = Some(out);
1089 }
1090 for block in self.order() {
1091 self.block(block)?;
1092 }
1093 // And the name each block an image holds the address of was given, which nothing in the
1094 // walk above would ask for: the `lea` a label address is inside the function needs no
1095 // symbol, and the one thing that does is a relocation in another section.
1096 let named: Vec<(Block, Symbol)> = self.source.named_blocks().collect();
1097 let labels: Vec<(mir::Block, Symbol)> =
1098 named.into_iter().map(|(block, name)| (self.out_block(block), name)).collect();
1099 self.out.labels = labels;
1100 self.naming();
1101 Ok(Lowered { func: self.out, stack: self.stack, fired: self.fired, blocks: self.blocks })
1102 }
1103
1104 /// Which register each declaration the front end kept in a value ended up in, as far as this
1105 /// walk can say, which is the other half of what [`Lowering::new_reg`] writes down as it goes.
1106 ///
1107 /// Two halves because there are two ways a value gets a register here. Most of them ask for a
1108 /// fresh one and that is where `new_reg` catches them, and the rest are put in a register
1109 /// something else chose: a parameter arrives in whichever one the convention handed it, a block
1110 /// parameter in whichever one the edge agreed on, and a result of a rule that names its own
1111 /// registers in the one the rule named. None of those goes past the mint, so this is the map at
1112 /// the end read off the other side, and the two together are every value a declaration is
1113 /// behind.
1114 ///
1115 /// The map on its own would not do, which is why `new_reg` writes down what it writes down: the
1116 /// entry for a constant is cleared every time the walk leaves the block that wrote it, so a
1117 /// local a constant holds is in the map for one block of the function and nowhere else.
1118 fn naming(&mut self) {
1119 let mut named = std::mem::take(&mut self.out.named);
1120 for value in self.source.values() {
1121 let Some(reg) = self.regs[value.index()] else { continue };
1122 named.extend(self.source.value_decls(value).map(|decl| (decl, reg)));
1123 // A start in a block a pass took out was never reached above, and it says nothing
1124 // rather than something about another place.
1125 for start in self.source.value_starts(value) {
1126 let Some((block, after)) = self.source.start_place(start) else { continue };
1127 let first = self.marks.get(&block).and_then(|marks| {
1128 marks.iter().find(|&&(have, _)| have == after).and_then(|&(_, at)| at)
1129 });
1130 if let Some(first) = first {
1131 self.out.starts.push((start.decl, reg, first));
1132 }
1133 }
1134 }
1135 named.sort_unstable();
1136 named.dedup();
1137 self.out.named = named;
1138 self.out.starts.sort_unstable();
1139 self.out.starts.dedup();
1140 // Which of its values a declaration holds on the way into a block, for the blocks where
1141 // two of them are live at once. A block a pass took out says nothing, and neither does a
1142 // value the map above has lost the register of, since that is not the same as having none.
1143 let mut entries = Vec::new();
1144 for (decl, block, value) in crate::holding::on_entry(self.source) {
1145 if let (Some(block), Some(reg)) = (self.blocks[block.index()], self.regs[value.index()])
1146 {
1147 entries.push((decl, block, reg));
1148 }
1149 }
1150 entries.sort_unstable();
1151 entries.dedup();
1152 self.out.entries = entries;
1153 }
1154
1155 /// The order the blocks are filled in, which is not the order they are written in.
1156 ///
1157 /// Reverse postorder, because a value is written in a block that dominates every block that
1158 /// reads it and a block in reverse postorder comes before every block it dominates. The order
1159 /// the blocks are written in does not have that property: a block written early can read a
1160 /// value a block below it writes, and reading a value with no register yet mints one, so the
1161 /// register the definition writes later is not the register the read named. Nothing writes the
1162 /// one the read named, and what comes out is a function that loads a stack slot no store ever
1163 /// reached. It is the order this walk goes in rather than the order the blocks come out in,
1164 /// which is what the loop above fixes, so the machine function is still written the way the IR
1165 /// function was.
1166 ///
1167 /// Blocks the entry does not reach come last, in the order they are written in. Nothing runs
1168 /// them and nothing they name is read by anything that does, but they still have to be filled,
1169 /// because a machine block with no terminator is not one the passes below can read.
1170 fn order(&self) -> Vec<Block> {
1171 let Some(entry) = self.source.entry() else { return self.source.blocks().collect() };
1172 let count = self.blocks.len();
1173 let mut succs: Vec<Vec<Block>> = vec![Vec::new(); count];
1174 for block in self.source.blocks() {
1175 let Some(term) = self.source.terminator(block) else { continue };
1176 succs[block.index()] = self.source.successors(term).map(|call| call.block).collect();
1177 }
1178 // An explicit stack, because the depth of the walk is the number of blocks and a function
1179 // built by a generator has as many of those as it likes.
1180 let mut seen = vec![false; count];
1181 let mut order = Vec::with_capacity(count);
1182 let mut stack = vec![(entry, 0usize)];
1183 seen[entry.index()] = true;
1184 while let Some((block, at)) = stack.pop() {
1185 let Some(&next) = succs[block.index()].get(at) else {
1186 order.push(block);
1187 continue;
1188 };
1189 stack.push((block, at + 1));
1190 if !seen[next.index()] {
1191 seen[next.index()] = true;
1192 stack.push((next, 0));
1193 }
1194 }
1195 order.reverse();
1196 order.extend(self.source.blocks().filter(|block| !seen[block.index()]));
1197 order
1198 }
1199
1200 /// One block: its parameters, then every instruction in it that is not folded into another.
1201 fn block(&mut self, block: Block) -> Result<(), Unsupported> {
1202 let out = self.out_block(block);
1203 self.at = Some(out);
1204 if self.source.entry() == Some(block) {
1205 self.arrive(block, out)?;
1206 } else {
1207 let mut arriving = Vec::new();
1208 for ¶m in &self.source[block].params {
1209 // A value with no register to arrive in, which the class would not say, since
1210 // `class_of` puts one of these in the general purpose file on purpose and what it
1211 // means by that is that nothing there can hold it. What crosses the edge for one
1212 // of those is the address of where the value already is, so the parameter is a
1213 // pointer here and the bytes it points at are copied below.
1214 let ty = self.source[param].ty;
1215 let reg = self.out.append_param(out, self.class_of(ty));
1216 self.regs[param.index()] = Some(reg);
1217 if on_x87(ty) {
1218 arriving.push((param, reg));
1219 }
1220 }
1221 self.settle(block, &arriving)?;
1222 }
1223
1224 // What each instruction matched, and which instructions were folded into another. The
1225 // decision is made for the whole block before any of it is written, and it is made more
1226 // than once: a value that only some of its readers took has to be put back in a register
1227 // for all of them, and taking it away from those readers changes what they match.
1228 let insts: Vec<Inst> = self.source.insts(block).collect();
1229 let mut refused: HashSet<Value> = HashSet::new();
1230 let mut decided = self.decide(&insts, &refused);
1231 while let Some(value) = self.left_alive(&insts, &decided.plans) {
1232 refused.insert(value);
1233 decided = self.decide(&insts, &refused);
1234 }
1235 let Decided { found, folded, .. } = decided;
1236
1237 // Where each assignment in this block that starts a declaration on a value is, as the
1238 // machine instruction in front of the place its IR instruction left off, or the block
1239 // for one where nothing has been written yet. What comes after it is not known until the
1240 // block is filled, so that is read below.
1241 let wanted: HashSet<Option<Inst>> =
1242 self.marks.get(&block).into_iter().flatten().map(|&(after, _)| after).collect();
1243 let mut reached: Vec<(Option<Inst>, mir::Block, Option<mir::Inst>)> = Vec::new();
1244 for (index, (&inst, matched)) in insts.iter().zip(found).enumerate() {
1245 let before = index.checked_sub(1).map(|index| insts[index]);
1246 if wanted.contains(&before) {
1247 let at = self.at.unwrap_or(out);
1248 reached.push((before, at, self.out.terminator(at)));
1249 }
1250 if folded.contains(&inst) || self.writes_nothing(inst) {
1251 continue;
1252 }
1253 // A call is built from the convention rather than matched, which is why it is the one
1254 // opcode looked at by name here. Through an address it is a different instruction and
1255 // the same convention, so the two arrive at the same place and differ in one line of
1256 // it.
1257 match self.source[inst].opcode {
1258 Opcode::Call | Opcode::CallIndirect => {
1259 self.called(inst)?;
1260 continue;
1261 }
1262 // Built from the frame rather than matched, for the same shape of reason a call
1263 // is built from the convention: what a rule replaces a term with is instructions,
1264 // and what an `alloca` needs first is bytes, which the rule language has no way
1265 // to ask for.
1266 Opcode::Alloca => {
1267 self.reserve(inst)?;
1268 continue;
1269 }
1270 // Reading the stack pointer and writing it back, which are the two ends of a scope
1271 // holding a variable length array. Built here for the reason an `alloca` is: the
1272 // value is a register the rule language has no way to name, because what it holds
1273 // is not a value the program computed but where the machine's stack had got to.
1274 // The arguments the function was handed, saved in the prologue, and a call made
1275 // out of them. Built here because neither is a value a rule could say anything
1276 // about: the first is a place in the frame and the second is a call, whose
1277 // arguments are a block of registers rather than values.
1278 Opcode::ApplyArgs => {
1279 self.apply_args(inst)?;
1280 continue;
1281 }
1282 Opcode::Apply => {
1283 self.apply(inst)?;
1284 continue;
1285 }
1286 Opcode::StackSave => {
1287 self.stack_pointer(inst, false)?;
1288 continue;
1289 }
1290 Opcode::StackRestore => {
1291 self.stack_pointer(inst, true)?;
1292 continue;
1293 }
1294 // The address of a name, built here for the same reason an `alloca` is: what a
1295 // rule replaces a term with is instructions over values, and the operand of this
1296 // one is a symbol, which is a thing the rule language has no way to bind and the
1297 // solver has no way to say anything about. There is nothing in `lea sym(%rip)` a
1298 // proof over bitvectors could discharge, because what makes it the right answer
1299 // is the relocation and what the linker does with it.
1300 Opcode::GlobalAddr => {
1301 self.address_of(inst)?;
1302 continue;
1303 }
1304 // The address of a label and the branch that reads one, built here for the same
1305 // reason and for one more. The reason is the same: what the first of them names is
1306 // a block, which is not a value a rule pattern can bind, and there is nothing in
1307 // the distance between two places in one function that a proof over bitvectors
1308 // could discharge. The extra one is that the second is a terminator whose arms are
1309 // not two and not fixed, and a rule says what an instruction reads rather than
1310 // where a block goes.
1311 Opcode::BlockAddr => {
1312 self.block_address(inst)?;
1313 continue;
1314 }
1315 Opcode::IndirectBr => {
1316 self.indirect_branch(inst)?;
1317 continue;
1318 }
1319 // A `switch` that `crate::switch` found dense enough for a table, which is a load
1320 // out of the table and the same jump. Built here for the reasons the jump above
1321 // is, and because what the load reads is a place in this function.
1322 Opcode::Switch => {
1323 self.jump_table(inst)?;
1324 continue;
1325 }
1326 // The pair that saves a place in this function and comes back to it. Built here
1327 // for the reason the address of a label is, and for two more. The reason is the
1328 // same: the first of them writes down where control comes back to, which is a
1329 // place in this function and not a value a rule pattern can bind. The extra ones
1330 // are that each of them is a group of instructions over a buffer the program owns
1331 // rather than one instruction, and that the first of them leaves the block it was
1332 // written in and carries on in a new one, which is a thing no rule can do.
1333 Opcode::SetjmpMarker => {
1334 self.saves_place(inst)?;
1335 continue;
1336 }
1337 Opcode::LongjmpMarker => {
1338 self.comes_back(inst)?;
1339 continue;
1340 }
1341 // Where this thread's own storage starts, built here for a reason of the same
1342 // shape: what it reads is `%fs`, which is not a register the rule language can
1343 // bind and not one a proof over bitvectors could say anything about, because what
1344 // makes the load the right answer is an agreement between the loader and the C
1345 // library rather than any arithmetic.
1346 Opcode::ThreadPointer => {
1347 self.thread_pointer(inst)?;
1348 continue;
1349 }
1350 // What a named machine register holds, built here for the reason above written
1351 // about any register rather than about one: which register it is is a string
1352 // beside the instruction, and a rule matches on an opcode and a type and could
1353 // not see it. There is nothing to prove either, since the answer is the register
1354 // and the instruction is the move that reads it.
1355 Opcode::RegisterValue => {
1356 self.register_value(inst)?;
1357 continue;
1358 }
1359 // Where a frame is and what it returns to, built here for the same reason and one
1360 // more. The reason is the same: what the walk starts from is the frame pointer,
1361 // which is not a register a rule pattern can bind, and there is nothing in reading
1362 // the link the prologue saved that a proof over bitvectors could discharge. The
1363 // extra one is that how long the walk is comes out of a number beside the
1364 // instruction, so one of these is not one instruction but however many the depth
1365 // says, and a rule replaces a term with a term.
1366 Opcode::FrameAddress | Opcode::ReturnAddress => {
1367 self.frames(inst)?;
1368 continue;
1369 }
1370 // Built from the frame for the reason an `alloca` is, and from the convention for
1371 // the reason a call is: three of the four fields it writes are distances that do
1372 // not exist until the frame does, and the fourth is where the walk over the
1373 // argument registers stopped. A function that is not variadic has no such walk to
1374 // report, so it has nothing here and is refused below, which is the right answer
1375 // for a `va_start` in one.
1376 Opcode::VaStart if self.varargs.is_some() => {
1377 self.va_start(inst)?;
1378 continue;
1379 }
1380 // A return of more than one value, which is a structure small enough to come
1381 // back in a pair of registers. Built from the convention for the reason a call
1382 // is: which register each half goes in depends on the halves in front of it,
1383 // because the two register files are walked separately, and a pattern over a term
1384 // cannot see them. A return of one value is a term with a name and a rule, and it
1385 // stays one.
1386 //
1387 // A return of none in a function whose answer went through memory is here too,
1388 // and for a different reason: what it gives back is not written in the IR at all.
1389 // The convention says the address the caller handed over comes back, and only the
1390 // signature says this function was handed one.
1391 //
1392 // And a return of one eighty bit value, for a third reason: what a rule would
1393 // write is an instruction leaving the value in a register, and this one is left on
1394 // the x87 stack instead. A rule could not name that stack any more than any other
1395 // rule about this type could.
1396 Opcode::Return
1397 if self.source[self.source[inst].args].len() > 1
1398 || self.sret().is_some()
1399 || self.gives_back_x87(inst) =>
1400 {
1401 self.returned(inst)?;
1402 continue;
1403 }
1404 // A cast between a pointer and an integer of the same width, which on this
1405 // machine is every one the front end writes. No instruction at all, so no rule
1406 // could name one.
1407 Opcode::PtrToInt | Opcode::IntToPtr => {
1408 self.rename(inst)?;
1409 continue;
1410 }
1411 // A barrier, which is one instruction or none depending on the ordering. Written
1412 // by name because there is nothing about it a rule could be proved against, the
1413 // way there is nothing to prove about the address of a symbol.
1414 Opcode::Fence => {
1415 self.barrier(inst)?;
1416 continue;
1417 }
1418 // An ordered load or store that `crate::expand::orderings` left alone, which on a
1419 // machine that is not total store order is every one stronger than relaxed. Written
1420 // by name for the barrier's reason: what it adds to the plain access is an ordering.
1421 Opcode::AtomicLoad | Opcode::AtomicStore if self.on_aarch64() => {
1422 self.ordered(inst)?;
1423 continue;
1424 }
1425 // A hint, written by name for the reason a barrier is and one step further: not
1426 // only is there no equality for a proof to discharge, there is nothing about the
1427 // program around it either. Which of the four instructions it is comes out of the
1428 // number the builtin was given, which is beside the instruction rather than in it.
1429 Opcode::Prefetch => {
1430 self.hint(inst)?;
1431 continue;
1432 }
1433 // Stopping, written by name for the first half of the barrier's reason: it
1434 // computes nothing, so there is no term for a rule to replace, and what makes it
1435 // right is what the operating system does with the fault rather than anything a
1436 // proof over bitvectors could discharge.
1437 Opcode::Trap => {
1438 self.trap(inst);
1439 continue;
1440 }
1441 // A compare and exchange, which is written by name because it produces two values
1442 // and a rule produces one. The replacement of a rule is one term, a term names the
1443 // value an instruction computes, and there is no way in that language to say that
1444 // an instruction leaves an answer in one place and a yes or no in another.
1445 Opcode::Cmpxchg => {
1446 self.exchange(inst)?;
1447 continue;
1448 }
1449 // A read modify write, which is written by name for a different reason: it produces
1450 // one value, so a rule could name it, and what it does is not in the head a rule
1451 // matches on. Every one of the thirteen operations is the same opcode at the same
1452 // type and differs only in what is carried beside it, so one pattern would be all
1453 // thirteen patterns. Of the thirteen only the three with an instruction reach here,
1454 // since `crate::retry` turned the rest into loops a long way above this.
1455 Opcode::AtomicRmw => {
1456 self.modify(inst)?;
1457 continue;
1458 }
1459 // An `asm` statement, whose lowering is its template and there is no term for a
1460 // string. Written by name for the reason a barrier is, and before the x87 arm
1461 // below so that an `asm` holding a `long double` is refused as the `asm` it is
1462 // rather than as an instruction nothing computes.
1463 Opcode::InlineAsm => {
1464 // The template is read as x86 assembly, and that reader is the only one there
1465 // is. AArch64 keeps every template as text, and any other machine's `asm` is
1466 // refused here rather than read as the wrong language.
1467 if self.on_aarch64() {
1468 self.spelled(inst)?;
1469 continue;
1470 }
1471 if !std::ptr::eq(self.selector.shapes, &x86_64::MACHINE) {
1472 return Err(self.unsupported(inst));
1473 }
1474 self.assembly(inst)?;
1475 continue;
1476 }
1477 // Anything at all with an eighty bit float in it, which is the one arm here
1478 // chosen by a type rather than by an opcode, because what makes these different
1479 // is not what they do but where the value is. A `long double` has no register,
1480 // so it has no name in `crate::term` and no rule could bind one: every one of
1481 // these is a group of instructions over a frame slot, written out below.
1482 //
1483 // Last of the arms, so that a call and a return with one of these in them reach
1484 // the convention first and are refused by it, which is the truer answer: what is
1485 // wrong there is where the value has to travel and not that nothing can compute
1486 // it.
1487 _ if self.touches_x87(inst) => {
1488 self.x87(inst)?;
1489 continue;
1490 }
1491 _ => {}
1492 }
1493 let matched = matched.ok_or_else(|| self.unsupported(inst))?;
1494 self.emit(inst, &matched)?;
1495 // After it is built rather than when it matched, so that what is recorded is the rules
1496 // this function was lowered by and not the rules something was tried with.
1497 self.fired.mark(matched.rule);
1498 }
1499 // Whichever block the walk ended in rather than the one it started in. The two are the
1500 // same block for every function that does not save a place for a `__builtin_longjmp`, and
1501 // where they differ it is the last of them that the terminator and the arms belong to.
1502 // See [`Self::saves_place`].
1503 let last = self.at.expect("a block is being filled");
1504 self.edges(block, last)?;
1505 // Now that the block is filled, the instruction after each place an assignment was is the
1506 // first one it holds its value at. One with nothing after it, which a block ending in the
1507 // assignment would be, stays unanswered.
1508 if let Some(marks) = self.marks.get_mut(&block) {
1509 for &(before, at, last) in &reached {
1510 let first = match last {
1511 Some(last) => self.out.next_inst(last),
1512 None => self.out.insts(at).next(),
1513 };
1514 for mark in marks.iter_mut().filter(|(after, _)| *after == before) {
1515 mark.1 = first;
1516 }
1517 }
1518 }
1519 Ok(())
1520 }
1521
1522 /// One call, which is built from the convention rather than matched against the table for the
1523 /// same reason the arguments of the function itself are.
1524 ///
1525 /// The arguments are read before the call is built, which is what materializes a constant
1526 /// argument into a register, since no call passes an immediate.
1527 ///
1528 /// A call to a name and a call through an address are both here, and what tells them apart is
1529 /// the opcode rather than whether a callee was recorded, which is the same thing the verifier
1530 /// reads. Through an address the first operand is the address and the arguments are the ones
1531 /// behind it, and everything after that is the same: where each argument goes, where the value
1532 /// comes back and which registers are gone across it are the convention's answers and the
1533 /// convention does not ask what is being called.
1534 fn called(&mut self, inst: Inst) -> Result<(), Unsupported> {
1535 let data = &self.source[inst];
1536 let Extra::Call(info) = data.extra else { return Err(self.unsupported(inst)) };
1537 let info = self.source[info];
1538 let indirect = data.opcode == Opcode::CallIndirect;
1539
1540 let values: Vec<Value> = self.source[data.args].to_vec();
1541 let callee = if indirect {
1542 let &address = values.first().ok_or_else(|| self.unsupported(inst))?;
1543 abi::Callee::Through(self.reg_of(address)?)
1544 } else {
1545 abi::Callee::Named(info.callee.ok_or_else(|| self.unsupported(inst))?)
1546 };
1547
1548 // What the ABI asks of each argument, read out before any of them is, because reading one
1549 // borrows the function this is a table in. The ones the signature names are the signature's
1550 // answer and the ones behind them are the call's, which is where a structure passed to a
1551 // variadic callee by value says that its bytes travel: there is no parameter to say it on.
1552 let signature = &self.source[info.signature];
1553 let variadic = signature.variadic;
1554 let named: Vec<Abi> = signature.params.iter().map(|param| param.abi).collect();
1555 let beyond: Vec<Abi> = self.source[info.varargs].to_vec();
1556 // Every value that comes back and not only the first. A structure small enough to travel
1557 // in registers comes back in up to two of them, and which register each half is in is the
1558 // convention's answer, which is why the whole list goes to the same place the arguments do
1559 // rather than to a rule.
1560 let returns: Vec<Type> = signature.return_types().collect();
1561
1562 let mut args = Vec::with_capacity(values.len());
1563 for (index, value) in values.into_iter().skip(usize::from(indirect)).enumerate() {
1564 let abi = named.get(index).or_else(|| beyond.get(index - named.len()));
1565 let abi = abi.copied().unwrap_or_default();
1566 let ty = self.source[value].ty;
1567 // What travels for an eighty bit value is its bytes, so what the call is handed is
1568 // where they are rather than a register they are in, and there is no register they
1569 // could be in. Everything else about it is a sixteen byte object passed by value and
1570 // is built by the same code.
1571 let reg =
1572 if abi::on_the_stack(ty) { self.x87_slot(value) } else { self.reg_of(value)? };
1573 args.push(abi::Passing { ty, reg, abi });
1574 }
1575 let block = self.at.expect("a block is being filled");
1576 let what = abi::Calling {
1577 callee,
1578 args: &args,
1579 returns: &returns,
1580 variadic,
1581 named: named.len(),
1582 at: self.source.span(inst),
1583 };
1584 let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
1585 .map_err(|refused| Unsupported::Call { inst, refused })?;
1586 let calls = &mut self.stack.calls;
1587 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
1588 // An eighty bit value came back on the x87 stack, and the one thing that has to happen
1589 // before anything else touches that stack is taking it off. So the `fstp` goes here, in
1590 // front of everything the block does next, and after it the value is in its slot and is
1591 // read the way every other one is. A complex one is two of them, the real half on top, so
1592 // taking them off in order leaves each in its own slot and the stack empty.
1593 let results: Vec<Value> = self.source[inst].results().collect();
1594 let types: Vec<Type> = results.iter().map(|&result| self.source[result].ty).collect();
1595 if abi::back_on_x87(&types) {
1596 let span = self.source.span(inst);
1597 for result in results {
1598 let into = self.x87_slot(result);
1599 let into = self.through(into);
1600 self.x87_at("fstp_t", span, into);
1601 }
1602 return Ok(());
1603 }
1604 for (result, ®) in results.into_iter().zip(&made.results) {
1605 self.regs[result.index()] = Some(reg);
1606 }
1607 Ok(())
1608 }
1609
1610 /// The pointer a function returning through memory was handed, or nothing in a function that
1611 /// was not.
1612 ///
1613 /// It is the first parameter and the signature is what says so, since in the IR it is an
1614 /// ordinary pointer and reads like one everywhere in the body. A function with a signature
1615 /// like that and no entry block has nothing to give back and no body to give it back from.
1616 fn sret(&self) -> Option<Value> {
1617 let first = self.source.signature().params.first()?;
1618 if !matches!(first.abi, Abi::Sret { .. }) {
1619 return None;
1620 }
1621 self.source[self.source.entry()?].params.first().copied()
1622 }
1623
1624 /// One `return` the convention has to write, as the place each value has to be in by the end.
1625 ///
1626 /// One pseudo per value, each a read constrained to a return register, which is what a return
1627 /// of one value already is and is the whole of what either does. The `ret` itself comes from
1628 /// the epilogue for both, long after this, because the frame has to be given back first.
1629 ///
1630 /// The two register files are counted separately, so a structure of a `double` and a `long`
1631 /// leaves the `double` in the first vector register and the `long` in the first integer one
1632 /// rather than in the second of either. That is the same walk `rucc_codegen::abi` makes on
1633 /// the other side of the call, which is what makes the two ends agree.
1634 ///
1635 /// A function whose answer went through memory gives back the address it was handed, in front
1636 /// of nothing else, because a signature that returns that way returns nothing else. That the
1637 /// caller already knows the address is not enough: it is allowed to read the register instead,
1638 /// and a caller that does gets whatever the allocator last left there. In a leaf function that
1639 /// is usually the right answer by accident, and one call in the body is enough to make it a
1640 /// wild pointer, which is why this is written rather than left to luck.
1641 ///
1642 /// Where everything goes is worked out before anything is written, so a return this cannot
1643 /// make leaves no half of one behind.
1644 /// Whether what a `return` gives back goes back on the x87 stack, per [`abi::back_on_x87`].
1645 fn gives_back_x87(&self, inst: Inst) -> bool {
1646 let values = &self.source[self.source[inst].args];
1647 let types: Vec<Type> = values.iter().map(|&value| self.source[value].ty).collect();
1648 abi::back_on_x87(&types)
1649 }
1650
1651 fn returned(&mut self, inst: Inst) -> Result<(), Unsupported> {
1652 let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
1653 let (mut ints, mut floats) = (0usize, 0usize);
1654 let mut parts = Vec::with_capacity(values.len() + 1);
1655 // An eighty bit value goes back on the x87 stack, which is where the convention says it is
1656 // and is the one place a value is left rather than put in a register. So the whole of the
1657 // return is an `fld` of its slot, and the stack it leaves the value on is not empty at the
1658 // `ret`, which is the one time in this file that is true and is what the convention asks
1659 // for. What comes after is the epilogue, which gives the frame back and touches nothing in
1660 // the unit. A complex one loads its imaginary half first so that the real half ends up on
1661 // top of it, in `st(0)`, with the imaginary half under it in `st(1)`.
1662 if self.gives_back_x87(inst) && self.sret().is_none() {
1663 let span = self.source.span(inst);
1664 for &value in values.iter().rev() {
1665 let from = self.x87_slot(value);
1666 let from = self.through(from);
1667 self.x87_at("fld_t", span, from);
1668 }
1669 return Ok(());
1670 }
1671 for value in self.sret().into_iter().chain(values) {
1672 let ty = self.source[value].ty;
1673 let at = if crate::term::in_vector_file(ty) { &mut floats } else { &mut ints };
1674 // Why it cannot come back, and not only that it cannot. A type that travels nowhere
1675 // says so itself, and a type that travels perfectly well ran out of registers.
1676 let missing = abi::refuses(ty, self.selector.abi).unwrap_or(Missing::NoRoom);
1677 let name =
1678 (self.selector.abi.ret)(ty, *at).ok_or(Unsupported::Returned { inst, missing })?;
1679 *at += 1;
1680 // The register is the target's answer and not one worked out here, the same as it is
1681 // for a return of one value, so that both halves of a pair and every rule that writes
1682 // half of one are reading the same table.
1683 let opcode =
1684 name.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
1685 let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
1686 let [desc] = descs else { return Err(self.unsupported(inst)) };
1687 parts.push((self.names.intern(name), self.reg_of(value)?, *desc));
1688 }
1689
1690 let block = self.at.expect("a block is being filled");
1691 let span = self.source.span(inst);
1692 for (opcode, reg, desc) in parts {
1693 let operand = mir::Operand {
1694 reg,
1695 class: desc.class,
1696 role: desc.role,
1697 constraint: desc.constraint,
1698 };
1699 self.out.build(block, mir::Opcode::new(opcode)).at(span).operand(operand).finish();
1700 }
1701 Ok(())
1702 }
1703
1704 /// One `alloca`: the bytes it asks for go on the list the frame is laid out from, and the
1705 /// address of them is one instruction.
1706 ///
1707 /// The instruction is a `lea` off the stack pointer, which is the one register that reaches
1708 /// the frame in every function, and its displacement is left at nothing because there is no
1709 /// frame yet. Which instruction is waiting for which local is remembered, and
1710 /// [`crate::finish`] fills the numbers in after [`crate::frame::Frame`] has placed them.
1711 ///
1712 /// There is deliberately no rule for `alloca` and no name for one in [`crate::term`], and
1713 /// that is what stops it being folded into something else. An operand shown as the
1714 /// instruction that computed it is offered to the matcher by its name, so an `alloca` with no
1715 /// name is one no pattern can reach past, and the address it computes is always in a register
1716 /// by the time anything reads it.
1717 fn reserve(&mut self, inst: Inst) -> Result<(), Unsupported> {
1718 let data = &self.source[inst];
1719 // A variable length array carries the size it wants as an operand rather than in the
1720 // instruction, which is the whole of what tells the two apart here.
1721 if let Some(&size) = self.source[data.args].first() {
1722 return self.grow(inst, size);
1723 }
1724 let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1725 let info = self.source[mem];
1726 let size = u32::try_from(info.size)
1727 .map_err(|_| Unsupported::Dynamic { inst, growing: Growing::Huge })?;
1728 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1729
1730 // At least one, because the frame divides by the alignment and an object with no
1731 // alignment at all is one the front end had nothing to say about rather than one that may
1732 // go anywhere.
1733 let index = self.stack.locals.len();
1734 self.stack.locals.push(Local { size, align: info.align.max(1) });
1735 if let Some(decl) = self.source.mem_decl(mem) {
1736 self.stack.declared.push((index, decl));
1737 }
1738
1739 let block = self.at.expect("a block is being filled");
1740 let reg = self.new_reg(result);
1741 let span = self.source.span(inst);
1742 let lea = self.named(self.selector.frame.lea);
1743 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
1744 let made =
1745 self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1746 self.stack.addresses.push((made, index));
1747 Ok(())
1748 }
1749
1750 /// The other kind of `alloca`: one whose size the function does not know until it runs, which
1751 /// is what a variable length array is.
1752 ///
1753 /// Nothing about it is a slot the frame laid out, because the frame is laid out once and this
1754 /// happens as often as control reaches the declaration. The bytes come off the stack pointer
1755 /// where the declaration stands, which is two instructions:
1756 ///
1757 /// ```text
1758 /// sub sp, bytes the stack pointer moves down over the memory, which is what takes it
1759 /// lea reg, [sp+n] where the memory starts, which is above the outgoing argument area
1760 /// ```
1761 ///
1762 /// The displacement is left at nothing for the reason the constant kind leaves its own at
1763 /// nothing, and for a different number: that area belongs to the arguments of whatever this
1764 /// function calls, it stays at the bottom of the frame wherever the bottom has moved to, and
1765 /// how big it is is not known until every call in the function has been seen.
1766 ///
1767 /// The bytes are already a multiple of the stack pointer's alignment by the time they arrive,
1768 /// because [`crate::expand::rounds`] rounded them up in the IR, so nothing here has to mask the
1769 /// stack pointer afterwards and the stack pointer stays somewhere a call can be made from.
1770 ///
1771 /// Two instructions here and not always two in the finished function. On a command line that
1772 /// asked for the stack to be touched a page at a time, the subtraction becomes a loop that
1773 /// walks the same distance a page at a time, which [`crate::finish`] writes. That is why the
1774 /// instruction is written down in [`Stack::grown`] as well as left where it is.
1775 ///
1776 /// An array wanting more alignment than the convention leaves the stack pointer with does not
1777 /// reach here asking for it: [`crate::expand::rounds`] gives it the alignment in extra bytes
1778 /// and turns the array into a `ptr_add` of the offset that lands inside them, so what arrives
1779 /// is a block asking for the convention's alignment like any other. The refusal below is what
1780 /// answers IR that came from somewhere other than that pass, since forcing the alignment here
1781 /// would be a second rounding of a register the frame already rounded, and after it no
1782 /// constant reaches the rest of the frame from anywhere. See `Growing` in [`crate::frame`].
1783 fn grow(&mut self, inst: Inst, size: Value) -> Result<(), Unsupported> {
1784 let data = &self.source[inst];
1785 let Extra::Mem(mem) = data.extra else { return Err(self.unsupported(inst)) };
1786 let info = self.source[mem];
1787 if info.align > self.conv.stack_align {
1788 return Err(Unsupported::Dynamic { inst, growing: Growing::Aligned });
1789 }
1790 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1791 let bytes = self.reg_of(size)?;
1792
1793 let block = self.at.expect("a block is being filled");
1794 let span = self.source.span(inst);
1795 let stack = mir::Reg::physical(self.conv.stack_pointer);
1796 let grow = self.named(self.selector.frame.grow);
1797 let took = self
1798 .out
1799 .build(block, grow)
1800 .at(span)
1801 .operand(mir::Operand::write(stack, self.gpr))
1802 .operand(mir::Operand::read(stack, self.gpr))
1803 .operand(mir::Operand::read(bytes, self.gpr))
1804 .finish();
1805 self.stack.grown.push(took);
1806
1807 let reg = self.new_reg(result);
1808 let lea = self.named(self.selector.frame.lea);
1809 let sp = mir::Operand::read(stack, self.gpr);
1810 let made =
1811 self.out.build(block, lea).at(span).def(reg, self.gpr).mem(mir::Mem::at(sp)).finish();
1812 self.stack.dynamic.push(made);
1813 self.stack.grown_at.get_or_insert(inst);
1814 Ok(())
1815 }
1816
1817 /// Where the stack pointer is, kept so that something later can put it back.
1818 ///
1819 /// One move out of the stack pointer and one move into it, which is the whole of what the two
1820 /// halves are. What makes them worth writing is where the front end puts them: a scope holding
1821 /// a variable length array saves the stack pointer as it opens and puts it back as it closes,
1822 /// so a loop declaring one takes its bytes once round rather than once per iteration, and a
1823 /// jump out of the scope gives the bytes back on the way out.
1824 ///
1825 /// The value travels in an ordinary register the allocator hands out, so it may be spilled like
1826 /// any other, and a spill slot in a frame that grows is reached through the frame pointer,
1827 /// which is exactly the register that still means something after the stack pointer has moved.
1828 fn stack_pointer(&mut self, inst: Inst, into: bool) -> Result<(), Unsupported> {
1829 let data = &self.source[inst];
1830 let block = self.at.expect("a block is being filled");
1831 let span = self.source.span(inst);
1832 let stack = mir::Reg::physical(self.conv.stack_pointer);
1833 let mov =
1834 self.selector.frame.moves(self.gpr).expect("a class the target says how to move").mov;
1835 let mov = self.named(mov);
1836 let (write, read) = if into {
1837 let &saved = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
1838 (stack, self.reg_of(saved)?)
1839 } else {
1840 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
1841 (self.new_reg(result), stack)
1842 };
1843 self.out
1844 .build(block, mov)
1845 .at(span)
1846 .operand(mir::Operand::write(write, self.gpr))
1847 .operand(mir::Operand::read(read, self.gpr))
1848 .finish();
1849 // Only the write is a move of the stack pointer, and it is the one that makes the frame a
1850 // growing one. A read of it in a function that never writes it back is a function that
1851 // asked where the stack was and did nothing with the answer.
1852 if into {
1853 self.stack.grown_at.get_or_insert(inst);
1854 }
1855 Ok(())
1856 }
1857
1858 /// Whether an instruction has an eighty bit float anywhere in it.
1859 ///
1860 /// Producing one and reading one are the same question here, because what makes one of these
1861 /// different from every other instruction is not the operation but where the value is. A
1862 /// `long double` is on the x87 stack while it is being worked on and in a frame slot the rest
1863 /// of the time, and neither of those is somewhere the operand of a rule could point.
1864 fn touches_x87(&self, inst: Inst) -> bool {
1865 let data = &self.source[inst];
1866 data.results().any(|value| on_x87(self.source[value].ty))
1867 || self.source[data.args].iter().any(|&arg| on_x87(self.source[arg].ty))
1868 }
1869
1870 /// Everything that happens to an eighty bit float, as the group of instructions it is.
1871 ///
1872 /// The first six move one, and every one of those is a load, a store, or a load and a store at
1873 /// two different formats, because that is the whole of what this machine converts with: the
1874 /// x87 has no instruction that turns one thing on its stack into another, so a widening is
1875 /// `fld` of the narrow format and a narrowing is `fstp` of it.
1876 ///
1877 /// The rest work on one, and they are here rather than in a rule for the same reason the six
1878 /// are. An add is a push, a push, the add and a pop, and what passes between those four is the
1879 /// top of a stack nothing allocates from, so there is no value in the middle of the group for
1880 /// a pattern to bind or a replacement to name. The comparison is the same shape with its last
1881 /// two instructions folded into one opcode, which is where the byte it produces comes from.
1882 ///
1883 /// Every group leaves the stack as empty as it found it, which is what `spec/10-backend.md`
1884 /// section 10.8 asks of one and is why nothing in this file has to track a depth: each push
1885 /// below is answered by a pop a line or two later, so no two groups can ever be looking at
1886 /// the same eight registers.
1887 fn x87(&mut self, inst: Inst) -> Result<(), Unsupported> {
1888 match self.source[inst].opcode {
1889 Opcode::Load => self.x87_load(inst),
1890 Opcode::Store => self.x87_store(inst),
1891 Opcode::FPExt => self.x87_widen(inst),
1892 Opcode::FPTrunc => self.x87_narrow(inst),
1893 Opcode::SIToFP => self.x87_from_signed(inst),
1894 Opcode::FPToSI => self.x87_to_signed(inst),
1895 Opcode::FAdd => self.x87_arith(inst, "fadd_p"),
1896 Opcode::FSub => self.x87_arith(inst, "fsubr_p"),
1897 Opcode::FMul => self.x87_arith(inst, "fmul_p"),
1898 Opcode::FDiv => self.x87_arith(inst, "fdivr_p"),
1899 Opcode::FNeg => self.x87_flip(inst),
1900 Opcode::FCmp => self.x87_compare(inst),
1901 Opcode::FConst => self.x87_const(inst),
1902 _ => Err(self.unsupported(inst)),
1903 }
1904 }
1905
1906 /// The eighty bit parameters of a block, copied out of the addresses an edge handed over and
1907 /// into slots of the block's own.
1908 ///
1909 /// What crosses an edge for a value of this type is an address, because the value is sixteen
1910 /// bytes of the frame and no register holds any of it. The block cannot keep that address: a
1911 /// second edge into the same block hands over a second one, and a read after the block would
1912 /// then be a read of whichever edge was taken rather than of one place. So the block has a
1913 /// slot per parameter and the bytes are copied into it here, which is the move on an edge that
1914 /// every other type gets from the allocator.
1915 ///
1916 /// Every load runs before every store and the stores run backwards, so all of the values are
1917 /// on the x87 stack at once and nothing reads a slot another one has already written. That
1918 /// costs nothing in the ordinary case of one parameter and is what makes the back edge of a
1919 /// loop that swaps two of these work. It is also the reason for the limit: the stack is eight
1920 /// deep, and a block with more of these than that is refused rather than copied in an order
1921 /// that could be wrong.
1922 fn settle(&mut self, block: Block, arriving: &[(Value, mir::Reg)]) -> Result<(), Unsupported> {
1923 let Some(&(first, _)) = arriving.first() else { return Ok(()) };
1924 if arriving.len() > X87_DEPTH {
1925 let ty = self.source[first].ty;
1926 return Err(Unsupported::Phi { block, count: arriving.len(), ty });
1927 }
1928 // A block parameter comes from no instruction, so what this points at is the first thing
1929 // in the block, which is where a reader looking for the copy would look.
1930 let first_inst = self.source.insts(block).next();
1931 let span = first_inst.map_or(Span::DUMMY, |it| self.source.span(it));
1932 for &(_, reg) in arriving {
1933 let from = self.through(reg);
1934 self.x87_at("fld_t", span, from);
1935 }
1936 for &(param, _) in arriving.iter().rev() {
1937 let into = self.x87_slot(param);
1938 let into = self.through(into);
1939 self.x87_at("fstp_t", span, into);
1940 }
1941 Ok(())
1942 }
1943
1944 /// The frame slot an eighty bit value lives in, as its address in a fresh register.
1945 ///
1946 /// The slot is the value's for the whole function and is taken the first time somebody asks.
1947 /// The address is worked out again every time, which is a `lea` per use and is deliberate: one
1948 /// address kept in a register from the definition to the last use would hold a general purpose
1949 /// register open across everything in between, and a function with a handful of these in it
1950 /// would spend its registers on addresses of things rather than on things.
1951 fn x87_slot(&mut self, value: Value) -> mir::Reg {
1952 // An argument of the function has a slot already and it is the caller's. The convention
1953 // puts the bytes in the argument area and hands over where they are, so the address that
1954 // arrived is the answer and no second copy of the value is made. Nothing ever writes to a
1955 // value of this type once it exists, so nothing writes to the caller's copy either. A
1956 // parameter of any other block is not this: what arrived there is an address a predecessor
1957 // chose, [`Lowering::settle`] has already copied the bytes out of it, and the slot those
1958 // bytes landed in is the one below.
1959 let entry = self.source.entry();
1960 if let (Def::Param { block, .. }, Some(reg)) =
1961 (self.source[value].def, self.regs[value.index()])
1962 {
1963 if entry == Some(block) {
1964 return reg;
1965 }
1966 }
1967 let index = match self.slots[value.index()] {
1968 Some(index) => index,
1969 None => {
1970 let index = self.stack.locals.len();
1971 self.stack.locals.push(Local { size: X87_BYTES, align: X87_BYTES });
1972 self.slots[value.index()] = Some(index);
1973 index
1974 }
1975 };
1976 let block = self.at.expect("a block is being filled");
1977 self.frame_address(block, index)
1978 }
1979
1980 /// The bytes a value crosses between a register and the x87 stack through, as their address
1981 /// in a fresh register.
1982 fn x87_crossing(&mut self) -> mir::Reg {
1983 let index = match self.crossing {
1984 Some(index) => index,
1985 None => {
1986 let index = self.stack.locals.len();
1987 self.stack.locals.push(Local { size: X87_CROSSING, align: X87_CROSSING });
1988 self.crossing = Some(index);
1989 index
1990 }
1991 };
1992 let block = self.at.expect("a block is being filled");
1993 self.frame_address(block, index)
1994 }
1995
1996 /// The two control words, as the address of the first of them in a fresh register.
1997 fn x87_control(&mut self) -> mir::Reg {
1998 let index = match self.control {
1999 Some(index) => index,
2000 None => {
2001 let index = self.stack.locals.len();
2002 self.stack.locals.push(Local { size: 4, align: 4 });
2003 self.control = Some(index);
2004 index
2005 }
2006 };
2007 let block = self.at.expect("a block is being filled");
2008 self.frame_address(block, index)
2009 }
2010
2011 /// An address held in a register, as the addressing mode that reaches it.
2012 fn through(&self, reg: mir::Reg) -> mir::Mem {
2013 mir::Mem::at(mir::Operand::read(reg, self.gpr))
2014 }
2015
2016 /// One instruction of a group, which names an address and nothing else.
2017 ///
2018 /// Every x87 instruction that moves a value is one of these. What it does to the stack is in
2019 /// the mnemonic rather than in an operand, so there is no register to write down and no
2020 /// register the allocator gets a say in.
2021 fn x87_at(&mut self, name: &str, span: Span, at: mir::Mem) {
2022 let block = self.at.expect("a block is being filled");
2023 let opcode = self.named(name);
2024 self.out.build(block, opcode).at(span).mem(at).finish();
2025 }
2026
2027 /// The one instruction of a group that reaches the program's own memory.
2028 ///
2029 /// A `long double` moves in two instructions with a frame slot at one end of them, and the
2030 /// other end is the address the program wrote. That end is the access, so it is the one that
2031 /// carries what the program said about it, and the trip through the slot is this compiler's
2032 /// own business the way a spill is. See [`Self::carried`].
2033 fn x87_touching(&mut self, name: &str, inst: Inst, at: mir::Mem) {
2034 let block = self.at.expect("a block is being filled");
2035 let opcode = self.named(name);
2036 let (span, flags) = (self.source.span(inst), self.carried(inst));
2037 self.out.build(block, opcode).at(span).flags(flags).mem(at).finish();
2038 }
2039
2040 /// One instruction of a group that names nothing at all.
2041 ///
2042 /// The arithmetic is these. Both of an add's operands are already on the stack when it runs
2043 /// and so is where the answer goes, and the stack is not somewhere an instruction says, so
2044 /// `faddp` has an argument in the assembler's syntax and nothing here for the argument to come
2045 /// from. What it works on is which two pushes came before it, which is a fact about the order
2046 /// of the group and is why the group is written in one place.
2047 fn x87_only(&mut self, name: &str, span: Span) {
2048 let block = self.at.expect("a block is being filled");
2049 let opcode = self.named(name);
2050 self.out.build(block, opcode).at(span).finish();
2051 }
2052
2053 /// A `load` of a `long double`: onto the stack from where it was, and off it into the slot.
2054 ///
2055 /// Two instructions rather than the two general purpose moves the same sixteen bytes would
2056 /// take, because `fld` and `fstp` at this format neither convert nor look: the value goes on
2057 /// in the format it was already in and comes back off in it, so a signalling NaN stays one
2058 /// and nothing is raised. Which is what makes this a copy at all.
2059 fn x87_load(&mut self, inst: Inst) -> Result<(), Unsupported> {
2060 let (args, result) = self.ends(inst)?;
2061 let &address = args.first().ok_or_else(|| self.unsupported(inst))?;
2062 let span = self.source.span(inst);
2063 let from = self.reg_of(address)?;
2064 let from = self.through(from);
2065 let into = self.x87_slot(result);
2066 let into = self.through(into);
2067 self.x87_touching("fld_t", inst, from);
2068 self.x87_at("fstp_t", span, into);
2069 Ok(())
2070 }
2071
2072 /// A `store` of a `long double`: the same pair the other way round.
2073 fn x87_store(&mut self, inst: Inst) -> Result<(), Unsupported> {
2074 let args = self.source[self.source[inst].args].to_vec();
2075 let [value, address] = args[..] else { return Err(self.unsupported(inst)) };
2076 let span = self.source.span(inst);
2077 let from = self.x87_slot(value);
2078 let from = self.through(from);
2079 let into = self.reg_of(address)?;
2080 let into = self.through(into);
2081 self.x87_at("fld_t", span, from);
2082 self.x87_touching("fstp_t", inst, into);
2083 Ok(())
2084 }
2085
2086 /// A `float`, a `double` or an integer becoming a `long double`.
2087 ///
2088 /// Through memory, because the x87 reads memory and nothing else: the value is in a register
2089 /// the machine has and the unit has no way to be handed one, so it is written to the crossing
2090 /// bytes and loaded back at the format that widens it. Every one of these is exact. Sixty four
2091 /// bits of significand and fifteen of exponent hold every `float`, every `double` and every
2092 /// sixty four bit integer outright, so none of the four can round and none can raise.
2093 fn x87_across(
2094 &mut self,
2095 inst: Inst,
2096 put: &'static str,
2097 class: RegClass,
2098 get: &'static str,
2099 ) -> Result<(), Unsupported> {
2100 let (args, result) = self.ends(inst)?;
2101 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2102 let span = self.source.span(inst);
2103 let value = self.reg_of(source)?;
2104 let across = self.x87_crossing();
2105 let across = self.through(across);
2106 let into = self.x87_slot(result);
2107 let into = self.through(into);
2108
2109 let block = self.at.expect("a block is being filled");
2110 let store = self.named(put);
2111 self.out.build(block, store).at(span).uses(value, class).mem(across).finish();
2112 self.x87_at(get, span, across);
2113 self.x87_at("fstp_t", span, into);
2114 Ok(())
2115 }
2116
2117 /// A `long double` becoming a `float`, a `double` or an integer.
2118 ///
2119 /// Through memory for the reason above and in the same three instructions backwards. The two
2120 /// that go to a float round to nearest, which is what the control word says unless somebody
2121 /// has changed it and is what C wants. The two that go to an integer do not, which is why they
2122 /// do not come here.
2123 fn x87_back(
2124 &mut self,
2125 inst: Inst,
2126 put: &'static str,
2127 get: &'static str,
2128 class: RegClass,
2129 ) -> Result<(), Unsupported> {
2130 let (args, result) = self.ends(inst)?;
2131 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2132 let span = self.source.span(inst);
2133 let from = self.x87_slot(source);
2134 let from = self.through(from);
2135 let across = self.x87_crossing();
2136 let across = self.through(across);
2137
2138 self.x87_at("fld_t", span, from);
2139 self.x87_at(put, span, across);
2140 let block = self.at.expect("a block is being filled");
2141 let reg = self.new_reg(result);
2142 let load = self.named(get);
2143 self.out.build(block, load).at(span).def(reg, class).mem(across).finish();
2144 Ok(())
2145 }
2146
2147 /// An `fpext` up to a `long double`, which is the only direction this machine has one in.
2148 fn x87_widen(&mut self, inst: Inst) -> Result<(), Unsupported> {
2149 let sse = self.conv.sse_class;
2150 match self.source[self.narrow(inst)?].ty.bits() {
2151 32 => self.x87_across(inst, "movss_mr", sse, "fld_s"),
2152 64 => self.x87_across(inst, "movsd_mr", sse, "fld_l"),
2153 _ => Err(self.unsupported(inst)),
2154 }
2155 }
2156
2157 /// An `fptrunc` down from a `long double`, which is the other direction of the same.
2158 fn x87_narrow(&mut self, inst: Inst) -> Result<(), Unsupported> {
2159 let sse = self.conv.sse_class;
2160 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2161 match self.source[result].ty.bits() {
2162 32 => self.x87_back(inst, "fstp_s", "movss_rm", sse),
2163 64 => self.x87_back(inst, "fstp_l", "movsd_rm", sse),
2164 _ => Err(self.unsupported(inst)),
2165 }
2166 }
2167
2168 /// A `sitofp` up to a `long double`.
2169 ///
2170 /// Thirty two bits and sixty four, and nothing narrower, because C widens an integer to `int`
2171 /// before it converts one and the front end writes that widening down. An unsigned integer is
2172 /// not here at all: `fild` reads its operand as signed, so a value above the signed range
2173 /// comes back short by two to the sixty fourth and has to be added back, which is arithmetic
2174 /// rather than a move and waits with the rest of it.
2175 fn x87_from_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2176 let gpr = self.gpr;
2177 match self.source[self.narrow(inst)?].ty.bits() {
2178 32 => self.x87_across(inst, "mov_mr_32", gpr, "fild_l"),
2179 64 => self.x87_across(inst, "mov_mr_64", gpr, "fild_ll"),
2180 _ => Err(self.unsupported(inst)),
2181 }
2182 }
2183
2184 /// An `fptosi` down from a `long double`, which is the one conversion here with no single
2185 /// instruction behind it.
2186 ///
2187 /// C cuts towards zero and the unit rounds the way its control word says, so the store that
2188 /// takes the value off the stack is wrapped in the control word being saved, changed and put
2189 /// back. Five instructions around the one that does the work, and three more moving the word
2190 /// through a register, because this machine has no way to OR a constant into memory at this
2191 /// width. The unit has a shorter answer in `fisttp`, and `spec/10-backend.md` section 10.8
2192 /// says why it is not used: it is SSE3, the x86-64 baseline is not, and there is nothing here
2193 /// that can gate an instruction on a feature yet.
2194 fn x87_to_signed(&mut self, inst: Inst) -> Result<(), Unsupported> {
2195 let (args, result) = self.ends(inst)?;
2196 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2197 let (put, get) = match self.source[result].ty.bits() {
2198 32 => ("fistp_l", "mov_rm_32"),
2199 64 => ("fistp_ll", "mov_rm_64"),
2200 _ => return Err(self.unsupported(inst)),
2201 };
2202 let span = self.source.span(inst);
2203 let gpr = self.gpr;
2204 let from = self.x87_slot(source);
2205 let from = self.through(from);
2206 let across = self.x87_crossing();
2207 let across = self.through(across);
2208 let control = self.x87_control();
2209 let saved = self.through(control).plus(0);
2210 let cut = self.through(control).plus(2);
2211
2212 // The word the unit has now, into the first of the two slots and into a register, with the
2213 // rounding field turned to truncate on the way to the second.
2214 self.x87_at("fnstcw", span, saved);
2215 let block = self.at.expect("a block is being filled");
2216 let was = self.out.new_vreg(gpr);
2217 let read = self.named("mov_rm_16");
2218 self.out.build(block, read).at(span).def(was, gpr).mem(saved).finish();
2219 let now = self.out.new_vreg(gpr);
2220 let set = self.named("or_ri_16");
2221 // Two address, which is written out here rather than taken from the two shorthands
2222 // because the shorthands leave an operand unconstrained: this machine ORs into the
2223 // register it read, so the two have to be the same one and only the constraint says so.
2224 self.out
2225 .build(block, set)
2226 .at(span)
2227 .operand(mir::Operand::write(now, gpr).with(Constraint::Reuse(1)))
2228 .operand(mir::Operand::read(was, gpr))
2229 .imm(X87_TRUNCATE)
2230 .finish();
2231 let write = self.named("mov_mr_16");
2232 self.out.build(block, write).at(span).uses(now, gpr).mem(cut).finish();
2233
2234 // The conversion itself, under the changed word, and then the word the unit had put back
2235 // before anything else runs.
2236 self.x87_at("fldcw", span, cut);
2237 self.x87_at("fld_t", span, from);
2238 self.x87_at(put, span, across);
2239 self.x87_at("fldcw", span, saved);
2240
2241 let block = self.at.expect("a block is being filled");
2242 let reg = self.new_reg(result);
2243 let load = self.named(get);
2244 self.out.build(block, load).at(span).def(reg, gpr).mem(across).finish();
2245 Ok(())
2246 }
2247
2248 /// A constant of this type, as the bits of it written into its slot.
2249 ///
2250 /// No x87 instruction at all, which is the surprise here. A slot holding an eighty bit value is
2251 /// the value, so a constant is ten bytes put where the value lives, and the unit never has to
2252 /// see it: whatever reads it will `fld` it out of the slot the way it reads any other one.
2253 ///
2254 /// Ten bytes in two goes, because the machine stores eight at a time and there is no store of
2255 /// an immediate to memory, so each half is put in a register first. The six bytes above the ten
2256 /// are left alone, since nothing reads them: they are the padding that makes the type sixteen
2257 /// wide and they are unspecified in the psABI rather than zero.
2258 ///
2259 /// The other way is a constant pool, an `fldt` of a symbol, and a relocation, which is what a
2260 /// compiler with somewhere to put a literal does. This back end has nowhere to put one yet, and
2261 /// four instructions in the frame is what that costs until it does.
2262 fn x87_const(&mut self, inst: Inst) -> Result<(), Unsupported> {
2263 let Extra::Imm(imm) = self.source[inst].extra else { return Err(self.unsupported(inst)) };
2264 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2265 let bits = self.source[imm].bits();
2266 let span = self.source.span(inst);
2267 let gpr = self.gpr;
2268 let slot = self.x87_slot(result);
2269 let low = self.through(slot).plus(0);
2270 let high = self.through(slot).plus(8);
2271
2272 let block = self.at.expect("a block is being filled");
2273 for (bytes, at, into) in
2274 [(bits as u64 as i64, low, "64"), (((bits >> 64) & 0xffff) as i64, high, "16")]
2275 {
2276 let held = self.out.new_vreg(gpr);
2277 let put = self.named(&format!("mov_ri_{into}"));
2278 self.out.build(block, put).at(span).def(held, gpr).imm(bytes).finish();
2279 let store = self.named(&format!("mov_mr_{into}"));
2280 self.out.build(block, store).at(span).uses(held, gpr).mem(at).finish();
2281 }
2282 Ok(())
2283 }
2284
2285 /// One arithmetic instruction on two eighty bit values, as the four it takes.
2286 ///
2287 /// The left operand is pushed first and the right one on top of it, so the left ends up
2288 /// underneath and the answer wanted is the one below against the top in that order. Which of
2289 /// the two mnemonics computes that is a question about the spelling rather than about the
2290 /// machine, and the two spellings disagree. Intel's `FSUBP ST(i), ST(0)` is `ST(i) - ST(0)`
2291 /// and is `DE E8+i`, and AT&T's `fsubp` is `DE E0+i`, which is the other subtraction. This
2292 /// compiler writes AT&T and encodes what gas encodes, so what it asks for here is `fsubr_p`
2293 /// and `fdivr_p`, and the `r` is not a reversal of anything the code generator decided.
2294 ///
2295 /// An addition and a multiplication have one form each and do not care, which is why a test
2296 /// that reads the mnemonic back would not have caught this and one that computes a subtraction
2297 /// and checks the answer does.
2298 ///
2299 /// The answer is left where the deeper of the two was and the shallower is gone, which is what
2300 /// the `p` on the mnemonic means, so one push has already been paid back by the time the
2301 /// `fstp` runs and the stack is level again after it.
2302 ///
2303 /// Nothing here is folded and nothing is reused. Two values that are the same value get two
2304 /// pushes of the same slot, and an operand that was just computed is read back out of the slot
2305 /// it was written to rather than left on the stack, which costs a store and a load per
2306 /// instruction in an expression. Keeping a partial result on the stack across the next
2307 /// instruction's operands means knowing how deep the stack is at every point in the block, and
2308 /// that is a different thing from writing a group.
2309 fn x87_arith(&mut self, inst: Inst, with: &'static str) -> Result<(), Unsupported> {
2310 let (args, result) = self.ends(inst)?;
2311 let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2312 let span = self.source.span(inst);
2313 let left = self.x87_slot(left);
2314 let left = self.through(left);
2315 let right = self.x87_slot(right);
2316 let right = self.through(right);
2317 let into = self.x87_slot(result);
2318 let into = self.through(into);
2319 self.x87_at("fld_t", span, left);
2320 self.x87_at("fld_t", span, right);
2321 self.x87_only(with, span);
2322 self.x87_at("fstp_t", span, into);
2323 Ok(())
2324 }
2325
2326 /// A negation, which is a push, the sign bit turned over and a pop.
2327 ///
2328 /// `fchs` does not read the value as a number, so this is right for a zero, for an infinity
2329 /// and for a NaN, and it raises nothing on any of them. Which is what C asks of a negation and
2330 /// is not what subtracting from zero would give: `0.0L - x` is a different answer at a
2331 /// negative zero and a signalling one at a NaN.
2332 fn x87_flip(&mut self, inst: Inst) -> Result<(), Unsupported> {
2333 let (args, result) = self.ends(inst)?;
2334 let &source = args.first().ok_or_else(|| self.unsupported(inst))?;
2335 let span = self.source.span(inst);
2336 let from = self.x87_slot(source);
2337 let from = self.through(from);
2338 let into = self.x87_slot(result);
2339 let into = self.through(into);
2340 self.x87_at("fld_t", span, from);
2341 self.x87_only("fchs", span);
2342 self.x87_at("fstp_t", span, into);
2343 Ok(())
2344 }
2345
2346 /// A comparison of two eighty bit values, as the two pushes and the one opcode that reads them.
2347 ///
2348 /// The right operand is pushed first and the left one on top of it, which is the other way
2349 /// round from the arithmetic and is because `fucomip` asks about the top against what is under
2350 /// it: the comparison this machine can do is the top's, so the value the predicate is about
2351 /// has to be the top. The pop that gets the loser off the stack and the byte that reads the
2352 /// flags are both inside the opcode, since what passes between those and the comparison is the
2353 /// flags and the flags are not something anything here can name.
2354 ///
2355 /// Which of the ten opcodes, and which way round, is the same table the vector comparisons
2356 /// match against in `rules/x86-64.rules`, and it has to stay the same table: a predicate that
2357 /// picked a different condition here than there would be a `long double` comparison that
2358 /// disagreed with the `double` comparison of the same two numbers, which is the one thing a
2359 /// wider format is not allowed to do.
2360 ///
2361 /// The always false and the always true are refused rather than folded into a constant,
2362 /// because a comparison this machine never has to do is one the optimizer should have removed
2363 /// and an instruction here that quietly agreed with it would hide that it did not.
2364 fn x87_compare(&mut self, inst: Inst) -> Result<(), Unsupported> {
2365 let Extra::FloatPred(pred) = self.source[inst].extra else {
2366 return Err(self.unsupported(inst));
2367 };
2368 let (args, result) = self.ends(inst)?;
2369 let [left, right] = args[..] else { return Err(self.unsupported(inst)) };
2370 // Two of the fourteen need a second byte and an instruction to put the two together,
2371 // because they are two conditions at once: an ordered equal is equal and not unordered,
2372 // and an unordered not equal is either. The opcode carries all of that and says here only
2373 // that it writes somewhere else as well.
2374 let (name, reversed, both) = match pred {
2375 FloatPred::Ogt => ("fucomip_set_a", false, false),
2376 FloatPred::Oge => ("fucomip_set_ae", false, false),
2377 FloatPred::Olt => ("fucomip_set_a", true, false),
2378 FloatPred::Ole => ("fucomip_set_ae", true, false),
2379 FloatPred::One => ("fucomip_set_ne", false, false),
2380 FloatPred::Ord => ("fucomip_set_np", false, false),
2381 FloatPred::Uno => ("fucomip_set_p", false, false),
2382 FloatPred::Ueq => ("fucomip_set_e", false, false),
2383 FloatPred::Ult => ("fucomip_set_b", false, false),
2384 FloatPred::Ule => ("fucomip_set_be", false, false),
2385 FloatPred::Ugt => ("fucomip_set_b", true, false),
2386 FloatPred::Uge => ("fucomip_set_be", true, false),
2387 FloatPred::Oeq => ("fucomip_set_e_and_np", false, true),
2388 FloatPred::Une => ("fucomip_set_ne_or_p", false, true),
2389 FloatPred::False | FloatPred::True => return Err(self.unsupported(inst)),
2390 };
2391 let (top, under) = if reversed { (right, left) } else { (left, right) };
2392
2393 let span = self.source.span(inst);
2394 let gpr = self.gpr;
2395 let under = self.x87_slot(under);
2396 let under = self.through(under);
2397 let top = self.x87_slot(top);
2398 let top = self.through(top);
2399 self.x87_at("fld_t", span, under);
2400 self.x87_at("fld_t", span, top);
2401
2402 let block = self.at.expect("a block is being filled");
2403 let reg = self.new_reg(result);
2404 // Taken before the instruction is started rather than inside it, since both come from the
2405 // same function being built and only one thing at a time may be adding to it.
2406 let spare = both.then(|| self.out.new_vreg(gpr));
2407 let opcode = self.named(name);
2408 let mut build = self.out.build(block, opcode).at(span).def(reg, gpr);
2409 if let Some(spare) = spare {
2410 build = build.def(spare, gpr);
2411 }
2412 build.finish();
2413 Ok(())
2414 }
2415
2416 /// The operands and the one result of an instruction that has exactly one.
2417 fn ends(&self, inst: Inst) -> Result<(&'a [Value], Value), Unsupported> {
2418 let data = &self.source[inst];
2419 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2420 Ok((&self.source[data.args], result))
2421 }
2422
2423 /// The operand of a conversion, which is the end of it that is not the `long double`.
2424 fn narrow(&self, inst: Inst) -> Result<Value, Unsupported> {
2425 let args = &self.source[self.source[inst].args];
2426 args.first().copied().ok_or_else(|| self.unsupported(inst))
2427 }
2428
2429 /// One `va_start`, as the fields of the list it was handed.
2430 ///
2431 /// On the four field list, two of them are numbers this already knows, and each costs an
2432 /// instruction to put in a register before it can be stored, because the machine here has no
2433 /// store of an immediate to memory. The other two are addresses in the frame, and each is a
2434 /// `lea` [`crate::finish`] finishes: the save area is one of the function's own stack objects,
2435 /// and the caller's argument area is where the parameters that had no register came from, which
2436 /// is the same place and the same fixup a parameter past the sixth already uses.
2437 ///
2438 /// On the list that is a pointer it is the second of those four and nothing else, since the
2439 /// whole of what that list says is where the walk is and the walk starts at the first argument
2440 /// the signature does not name. One `lea` and one store.
2441 ///
2442 /// What is written is exactly the fields [`crate::varargs`] describes, in the order they are
2443 /// laid out, so that reading this beside that table is the whole of the check.
2444 fn va_start(&mut self, inst: Inst) -> Result<(), Unsupported> {
2445 let Some(&list) = self.source[self.source[inst].args].first() else {
2446 return Err(self.unsupported(inst));
2447 };
2448 let started = self.varargs.ok_or_else(|| self.unsupported(inst))?;
2449 let list = self.reg_of(list)?;
2450 let block = self.at.expect("a block is being filled");
2451 let span = self.source.span(inst);
2452
2453 let (save, incoming) = match started {
2454 Varargs::Pointer { incoming } => (None, incoming),
2455 Varargs::Fields { save, incoming, integers, floats } => {
2456 let counts = [(varargs::GP_OFFSET, integers), (varargs::FP_OFFSET, floats)];
2457 for (at, count) in counts {
2458 self.store_small(list, at, i64::from(count), span);
2459 }
2460 (Some(save), incoming)
2461 }
2462 Varargs::Aapcs { save, incoming, integers_end, floats_end, integers, floats } => {
2463 let counts =
2464 [(varargs::aapcs::GR_OFFS, integers), (varargs::aapcs::VR_OFFS, floats)];
2465 for (at, count) in counts {
2466 self.store_small(list, at, i64::from(count), span);
2467 }
2468 let overflow = self.overflow(block, incoming, span);
2469 let integers_top = self.frame_address_plus(block, save, integers_end);
2470 let floats_top = self.frame_address_plus(block, save, floats_end);
2471 let fields = [
2472 (varargs::aapcs::STACK, overflow),
2473 (varargs::aapcs::GR_TOP, integers_top),
2474 (varargs::aapcs::VR_TOP, floats_top),
2475 ];
2476 for (at, held) in fields {
2477 self.store_word(list, at, held, span);
2478 }
2479 return Ok(());
2480 }
2481 };
2482
2483 // At the front of the list when that address is the whole of it, and at the field the
2484 // layout gives it when there are four, with the save area behind it.
2485 let overflow = self.overflow(block, incoming, span);
2486 let fields = match save {
2487 None => vec![(0, overflow)],
2488 Some(save) => {
2489 let save = self.frame_address(block, save);
2490 vec![(varargs::OVERFLOW, overflow), (varargs::SAVE_AREA, save)]
2491 }
2492 };
2493 for (at, held) in fields {
2494 self.store_word(list, at, held, span);
2495 }
2496 Ok(())
2497 }
2498
2499 /// The first argument the signature did not name, which is as far up the caller's argument
2500 /// area as the ones it did name reached. Nothing here knows where that area is, so the distance
2501 /// is recorded the way a parameter read out of it is and finished with it.
2502 fn overflow(&mut self, block: mir::Block, incoming: u32, span: Span) -> mir::Reg {
2503 let overflow = self.out.new_vreg(self.gpr);
2504 let lea = self.named(self.selector.frame.lea);
2505 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
2506 let made = self
2507 .out
2508 .build(block, lea)
2509 .at(span)
2510 .def(overflow, self.gpr)
2511 .mem(mir::Mem::at(sp))
2512 .finish();
2513 self.stack.arguments.push((made, incoming));
2514 overflow
2515 }
2516
2517 /// Writes a small constant into a 32 bit field of a list.
2518 fn store_small(&mut self, list: mir::Reg, at: i64, value: i64, span: Span) {
2519 let block = self.at.expect("a block is being filled");
2520 let held = self.out.new_vreg(self.gpr);
2521 let load = mir::Opcode::new(self.names.intern(self.selector.abi.small));
2522 self.out.build(block, load).at(span).def(held, self.gpr).imm(value).finish();
2523
2524 let head = (self.selector.abi.store)(Type::int(32)).expect("a store of a word");
2525 let store = mir::Opcode::new(self.names.intern(head));
2526 let mem = self.field(list, at);
2527 self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2528 }
2529
2530 /// Writes an address into a pointer field of a list.
2531 fn store_word(&mut self, list: mir::Reg, at: i64, held: mir::Reg, span: Span) {
2532 let block = self.at.expect("a block is being filled");
2533 let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
2534 let store = mir::Opcode::new(self.names.intern(head));
2535 let mem = self.field(list, at);
2536 self.out.build(block, store).at(span).uses(held, self.gpr).mem(mem).finish();
2537 }
2538
2539 /// One field of a list, as the addressing mode that reaches it.
2540 fn field(&self, list: mir::Reg, at: i64) -> mir::Mem {
2541 let base = mir::Operand::read(list, self.gpr);
2542 mir::Mem::at(base).plus(i32::try_from(at).expect("a field of a list is a small offset"))
2543 }
2544
2545 /// The address of a name: one `lea` off the instruction pointer, with the name on it.
2546 ///
2547 /// That is x86-64, and [`Selector::symbols`] is what says so. AArch64 writes the same thing as
2548 /// an `adrp` of the page and an `add` of the low twelve bits, which is one opcode with the name
2549 /// as its own symbol and no addressing mode, and the table read is an `adrp` and an `ldr`.
2550 ///
2551 /// The same instruction an `alloca` gets and for a related reason. An address that is not in
2552 /// the program is a `lea` of an addressing mode that names no register, and the mode carries
2553 /// the symbol so that [`rucc_asm`] can write it relative to `%rip` and leave the relocation
2554 /// for the assembler. Both halves of that already existed: the printer writes `sym(%rip)` and
2555 /// the encoder emits the relocation, because a call to a name the file does not define needed
2556 /// them first.
2557 ///
2558 /// One `mov` and not one `lea` when the name is one [`Elsewhere`] holds, because the distance
2559 /// the `lea` adds to the instruction pointer is a number only a link that puts the name in
2560 /// this program can work out, and the address of a function this file merely declares is not
2561 /// such a number. The load reads the address out of the slot the linker fills in instead. The
2562 /// linker turns it back into the `lea` when the name turns out to have been here all along,
2563 /// so this is not slower in the case that was already right.
2564 ///
2565 /// There is deliberately no name for this in [`crate::term`], which is what stops the address
2566 /// being folded into the instruction that reads it. Folding it is the right thing to do and
2567 /// is what turns a load of a global from two instructions into one, but it is a separate
2568 /// question about addressing modes and issue #282 is it. Until then the address is in a
2569 /// register before anything uses it, which is correct and one instruction longer.
2570 ///
2571 /// What this does not do is give the name anything to refer to. A module carries its globals
2572 /// and nothing writes them out, so a file that defines the variable it reads compiles to a
2573 /// reference the linker cannot resolve. Issue #293 is the other half.
2574 ///
2575 /// A thread-local variable is neither of the two above and is [`Self::thread_address`].
2576 fn address_of(&mut self, inst: Inst) -> Result<(), Unsupported> {
2577 let data = &self.source[inst];
2578 let Extra::Symbol(symbol) = data.extra else { return Err(self.unsupported(inst)) };
2579 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2580 if self.elsewhere.thread(symbol) {
2581 return self.thread_address(inst, symbol, result);
2582 }
2583
2584 let block = self.at.expect("a block is being filled");
2585 let reg = self.new_reg(result);
2586 let span = self.source.span(inst);
2587 let far = self.elsewhere.holds(symbol);
2588 let symbols = self.selector.symbols;
2589 match if far { symbols.far } else { symbols.near } {
2590 Reach::Mode(name) => {
2591 let mem = if far { mir::Mem::got(symbol) } else { mir::Mem::of(symbol) };
2592 let opcode = self.named(name);
2593 self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2594 }
2595 Reach::Own(name) => {
2596 let opcode = self.named(name);
2597 self.out.build(block, opcode).at(span).def(reg, self.gpr).symbol(symbol).finish();
2598 }
2599 }
2600 Ok(())
2601 }
2602
2603 /// The address of a thread-local variable, which is this thread's copy of it.
2604 ///
2605 /// Neither instruction the ordinary case writes would mean anything here. There is no distance
2606 /// to the variable for a `lea` to add, because there is no variable: there is one copy of it per
2607 /// thread and they are at different addresses, so a link asked for the distance to the name
2608 /// refuses rather than picking one. And there is no address for a table slot to hold either, for
2609 /// the same reason.
2610 ///
2611 /// What is the same in every thread is where the variable sits inside the block of storage a
2612 /// thread gets, so that offset is what the link writes down, and the address of the running
2613 /// thread's block is what turns it into an address. x86-64 keeps that address in `%fs`, at the
2614 /// front of the block, so the whole of this is three instructions:
2615 ///
2616 /// ```text
2617 /// movq x@gottpoff(%rip), %off # how far into the block x sits, which the link fills in
2618 /// movq %fs:0, %tp # where this thread's block is, which only the machine knows
2619 /// addq %tp, %off # this thread's copy of x
2620 /// ```
2621 ///
2622 /// That is the initial exec model. It is one instruction longer than what gcc writes at `-O2`
2623 /// in an executable, which folds the addition into the instruction that uses the address, and
2624 /// the difference is issue #282 rather than anything about threads: nothing here folds an
2625 /// address into its reader yet. The link relaxes the first instruction into an immediate when it
2626 /// is making an executable, since it lays the blocks out and therefore knows the number, so the
2627 /// table slot costs nothing in the case that is common.
2628 ///
2629 /// It is not the most general model. A library loaded by `dlopen` gets its storage after the
2630 /// program is already running, and the block this reaches was laid out before it started, so
2631 /// the loader has to find room in that block for the library's variables. glibc keeps a little
2632 /// spare room for exactly this and a library that fits in it loads and runs; one that does not
2633 /// fails to load, with a message saying so. The model with no such limit calls `__tls_get_addr`
2634 /// and is what gcc writes under `-fPIC` by default, and it is issue #1104.
2635 ///
2636 /// So this is the model gcc writes under `-ftls-model=initial-exec`: right for an executable,
2637 /// right for a library the program is linked against, and a load that either works or is
2638 /// refused out loud for a library something opens later. What it is never is quietly wrong.
2639 ///
2640 /// AArch64 Linux is the same three steps. The slot is reached with `adrp` and `ldr` against
2641 /// `:gottprel:`, the thread pointer is `tpidr_el0` read with `mrs`, and the add has three
2642 /// operands. Apple's platforms reach a thread-local variable through a descriptor call instead,
2643 /// which is [`Self::thread_descriptor`].
2644 fn thread_address(
2645 &mut self,
2646 inst: Inst,
2647 symbol: Symbol,
2648 result: Value,
2649 ) -> Result<(), Unsupported> {
2650 if self.elsewhere.described() {
2651 return self.thread_descriptor(inst, symbol, result);
2652 }
2653 let block = self.at.expect("a block is being filled");
2654 let span = self.source.span(inst);
2655 let gpr = self.gpr;
2656
2657 let offset = self.out.new_vreg(gpr);
2658 match self.selector.symbols.thread {
2659 Reach::Mode(name) => {
2660 let load = self.named(name);
2661 let mem = mir::Mem::thread(symbol);
2662 self.out.build(block, load).at(span).def(offset, gpr).mem(mem).finish();
2663 }
2664 Reach::Own(name) => {
2665 let load = self.named(name);
2666 self.out.build(block, load).at(span).def(offset, gpr).symbol(symbol).finish();
2667 }
2668 }
2669 let pointer = self.out.new_vreg(gpr);
2670 self.read_thread_pointer(block, span, pointer);
2671
2672 // Two address on x86-64, for the reason `x87_to_int` gives: that machine adds into the
2673 // register it read, and only the constraint says the two are the same one.
2674 let reg = self.new_reg(result);
2675 let jumps = self.selector.jumps;
2676 let add = self.named(jumps.add);
2677 let written = mir::Operand::write(reg, gpr);
2678 let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2679 self.out
2680 .build(block, add)
2681 .at(span)
2682 .operand(written)
2683 .operand(mir::Operand::read(offset, gpr))
2684 .operand(mir::Operand::read(pointer, gpr))
2685 .finish();
2686 Ok(())
2687 }
2688
2689 /// A thread-local variable on Mach-O, which is a call.
2690 ///
2691 /// The slot the machine's thread load reads holds the address of the variable's descriptor
2692 /// there, `_v@TLVP` on x86-64 and `_v@TLVPPAGE` with `_v@TLVPPAGEOFF` on AArch64. The first
2693 /// word of the descriptor is the function that finds this thread's copy, and it takes the
2694 /// descriptor's address as its one argument and gives back the copy's address. That is the
2695 /// sequence clang writes on both machines.
2696 ///
2697 /// The call is built as an ordinary call through an address, so it costs what any call costs:
2698 /// everything the convention does not preserve is taken to be gone across it. Apple's function
2699 /// keeps more than that, all but the result and the two scratch registers on AArch64, and
2700 /// taking the fewer registers as gone would be faster. What this gives up is speed, and a
2701 /// function that reads a thread-local is no longer a leaf.
2702 fn thread_descriptor(
2703 &mut self,
2704 inst: Inst,
2705 symbol: Symbol,
2706 result: Value,
2707 ) -> Result<(), Unsupported> {
2708 let block = self.at.expect("a block is being filled");
2709 let span = self.source.span(inst);
2710 let gpr = self.gpr;
2711
2712 let descriptor = self.out.new_vreg(gpr);
2713 match self.selector.symbols.thread {
2714 Reach::Mode(name) => {
2715 let load = self.named(name);
2716 let mem = mir::Mem::thread(symbol);
2717 self.out.build(block, load).at(span).def(descriptor, gpr).mem(mem).finish();
2718 }
2719 Reach::Own(name) => {
2720 let load = self.named(name);
2721 let build = self.out.build(block, load).at(span);
2722 build.def(descriptor, gpr).symbol(symbol).finish();
2723 }
2724 }
2725 let finder = self.out.new_vreg(gpr);
2726 let word = (self.selector.abi.load)(Type::PTR).ok_or_else(|| self.unsupported(inst))?;
2727 let word = mir::Opcode::new(self.names.intern(word));
2728 let mem = mir::Mem::at(mir::Operand::read(descriptor, gpr));
2729 self.out.build(block, word).at(span).def(finder, gpr).mem(mem).finish();
2730
2731 let args = [abi::Passing { ty: Type::PTR, reg: descriptor, abi: Abi::default() }];
2732 let what = abi::Calling {
2733 callee: abi::Callee::Through(finder),
2734 args: &args,
2735 returns: &[Type::PTR],
2736 variadic: false,
2737 named: 1,
2738 at: span,
2739 };
2740 let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
2741 .map_err(|refused| Unsupported::Call { inst, refused })?;
2742 let calls = &mut self.stack.calls;
2743 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
2744 let &[reg] = &made.results[..] else { return Err(self.unsupported(inst)) };
2745 self.regs[result.index()] = Some(reg);
2746 Ok(())
2747 }
2748
2749 /// Refuses the thread pointer where it is not written, which is Mach-O. Apple keeps it in a
2750 /// different register from the one Linux does on both machines, and nothing written for it
2751 /// has been checked on one.
2752 fn threads_written(&self, inst: Inst) -> Result<(), Unsupported> {
2753 if self.elsewhere.described() {
2754 return Err(Unsupported::Unported { inst: Some(inst), what: Unported::Thread });
2755 }
2756 Ok(())
2757 }
2758
2759 /// The front of this thread's block into `reg`.
2760 ///
2761 /// On x86-64 that is the one thing no instruction can work out: `%fs` is not a register a
2762 /// program can read, and what it points at is a word holding its own address, so reading
2763 /// through it at zero is how the address is come by. AArch64 keeps it in `tpidr_el0`, which
2764 /// `mrs` reads.
2765 fn read_thread_pointer(&mut self, block: mir::Block, span: Span, reg: mir::Reg) {
2766 let gpr = self.gpr;
2767 match self.selector.symbols.pointer {
2768 Pointer::Segment(name, segment) => {
2769 let load = self.named(name);
2770 let at = mir::Mem::in_segment(segment, 0);
2771 self.out.build(block, load).at(span).def(reg, gpr).mem(at).finish();
2772 }
2773 Pointer::Own(name) => {
2774 let read = self.named(name);
2775 self.out.build(block, read).at(span).def(reg, gpr).finish();
2776 }
2777 }
2778 }
2779
2780 /// `&&label`, GNU's address of a label, which is the same `lea` a global gets against a place
2781 /// in this same function.
2782 ///
2783 /// What the two have in common is the whole of the instruction: an address worked out from
2784 /// where the instruction is, which is what `(%rip)` means and is the only way this compiler
2785 /// reaches anything. What they do not have in common is what fills the four bytes in. A
2786 /// global is a name, so the number is a relocation and the linker writes it. A block is a
2787 /// place in this function, so both ends are in one section and the number is known as soon as
2788 /// the blocks have been laid out, which is why `rucc_asm` fills it in the way it fills in a
2789 /// jump rather than leaving a relocation behind.
2790 ///
2791 /// Nothing here says the block is one control can arrive at. That is said by the
2792 /// [`Opcode::IndirectBr`] that reads the address, which lists every block it can arrive at,
2793 /// and by nothing else: an address on its own is a number.
2794 fn block_address(&mut self, inst: Inst) -> Result<(), Unsupported> {
2795 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
2796 let Some(call) = self.source.successors(inst).next() else {
2797 return Err(self.unsupported(inst));
2798 };
2799 let block = self.at.expect("a block is being filled");
2800 let reg = self.new_reg(result);
2801 let span = self.source.span(inst);
2802 let opcode = self.named(self.selector.jumps.near);
2803 let mem = mir::Mem::block(self.out_block(call.block));
2804 self.out.build(block, opcode).at(span).def(reg, self.gpr).mem(mem).finish();
2805 Ok(())
2806 }
2807
2808 /// `goto *p`, GNU's computed goto, which is a jump through a register.
2809 ///
2810 /// Where it goes is not written here and cannot be. Every block it can arrive at is on the
2811 /// block this ends, the way every other arm is, and which of them the address holds is decided
2812 /// while the program runs. So this is one instruction with one operand, and the arms are
2813 /// copied across by [`Self::edges`] like anybody else's.
2814 fn indirect_branch(&mut self, inst: Inst) -> Result<(), Unsupported> {
2815 let data = &self.source[inst];
2816 let &address = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2817 let reg = self.reg_of(address)?;
2818 let block = self.at.expect("a block is being filled");
2819 let span = self.source.span(inst);
2820 let name = self.selector.branch.indirect;
2821 let opcode = self.named(name);
2822 self.out.build(block, opcode).at(span).operand(mir::Operand::read(reg, self.gpr)).finish();
2823 Ok(())
2824 }
2825
2826 /// A `switch` on an index from zero up, as a jump through a table of this function.
2827 ///
2828 /// Every `switch` that reaches here is one `crate::switch` left behind on purpose: it has
2829 /// already checked the value is inside the table and taken the lowest case off it, so the
2830 /// operand is a 64 bit index, the cases are the values from zero up with gaps where the
2831 /// program had no case, and the default is only where those gaps go. What is written is the
2832 /// shape gcc writes for the same statement in position independent code:
2833 ///
2834 /// ```text
2835 /// leaq table(%rip), %base
2836 /// movslq (%base,%index,4), %offset
2837 /// addq %base, %offset
2838 /// jmp *%offset
2839 /// ```
2840 ///
2841 /// The table holds distances from itself to each arm rather than addresses, which is what
2842 /// lets it be filled in by the assembler with nothing left for a linker to do. Each cell is
2843 /// stored as the place of an arm among this block's successors, which [`Self::edges`] copies
2844 /// across in the IR's own order, the default first and then one per case. See
2845 /// [`mir::Table`] for why a place and not a block.
2846 fn jump_table(&mut self, inst: Inst) -> Result<(), Unsupported> {
2847 let data = &self.source[inst];
2848 let Extra::Switch(info) = data.extra else { return Err(self.unsupported(inst)) };
2849 let &index = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2850 let ty = self.source[index].ty;
2851 if ty != Type::int(u64::BITS) {
2852 return Err(self.unsupported(inst));
2853 }
2854 let cases = self.source[self.source[info].cases].to_vec();
2855 let mut cells: Vec<u32> = Vec::new();
2856 for (arm, case) in cases.iter().enumerate() {
2857 let at = usize::try_from(case.signed(ty)).map_err(|_| self.unsupported(inst))?;
2858 if at >= cells.len() {
2859 cells.resize(at + 1, 0);
2860 }
2861 cells[at] = u32::try_from(arm + 1).map_err(|_| self.unsupported(inst))?;
2862 }
2863 let reg = self.reg_of(index)?;
2864 let block = self.at.expect("a block is being filled");
2865 let span = self.source.span(inst);
2866 let gpr = self.gpr;
2867 let table = u32::try_from(self.out.tables.len()).expect("fewer tables than that");
2868
2869 let jumps = self.selector.jumps;
2870
2871 let base = self.out.new_vreg(gpr);
2872 let near = self.named(jumps.near);
2873 self.out.build(block, near).at(span).def(base, gpr).mem(mir::Mem::table(table)).finish();
2874 let offset = self.out.new_vreg(gpr);
2875 let cell =
2876 mir::Mem::at(mir::Operand::read(base, gpr)).indexed(mir::Operand::read(reg, gpr), 4);
2877 let load = self.named(jumps.cell);
2878 self.out.build(block, load).at(span).def(offset, gpr).mem(cell).finish();
2879 // Two address on x86-64, for the reason `thread_pointer` gives.
2880 let to = self.out.new_vreg(gpr);
2881 let add = self.named(jumps.add);
2882 let written = mir::Operand::write(to, gpr);
2883 let written = if jumps.two_address { written.with(Constraint::Reuse(1)) } else { written };
2884 self.out
2885 .build(block, add)
2886 .at(span)
2887 .operand(written)
2888 .operand(mir::Operand::read(offset, gpr))
2889 .operand(mir::Operand::read(base, gpr))
2890 .finish();
2891 let jump = self.named(self.selector.branch.indirect);
2892 let jump =
2893 self.out.build(block, jump).at(span).operand(mir::Operand::read(to, gpr)).finish();
2894 self.out.tables.push(mir::Table { jump, cells });
2895 Ok(())
2896 }
2897
2898 /// `__builtin_setjmp`, which writes down where the function is so that a `__builtin_longjmp`
2899 /// somewhere else can bring control back here, and answers zero on the way past.
2900 ///
2901 /// Four words of the buffer, the three gcc writes and one of this compiler's own, and then the
2902 /// block ends: everything after the save in the IR block is put into a new machine IR block,
2903 /// and the address of that block is what went into the buffer. That is the whole reason the
2904 /// block is split here. An address points at a label, a machine IR block is the only thing in
2905 /// this representation that has one, and a save is in the middle of a block rather than at the
2906 /// end of one.
2907 ///
2908 /// # How the answer gets back
2909 ///
2910 /// Through the frame rather than through a register. The save writes a zero into a word of its
2911 /// own frame, puts the address of that word in the buffer, and the new block reads the word
2912 /// back. The restore writes a one through the address it finds in the buffer before it goes.
2913 /// So one load answers zero on the way past and one on the way back, and neither path has to
2914 /// agree with the other about a register.
2915 ///
2916 /// gcc does it the other way round, with a second block that sets the answer to one and is
2917 /// what the restore arrives at. That block is one nothing in the function jumps to, and a
2918 /// machine IR whose blocks are walked from the entry has nowhere to put such a thing: the
2919 /// allocator lays a function out in the line it is going to be emitted in, and a block no edge
2920 /// reaches is not in that line. The word in the frame costs eight bytes of stack and one load,
2921 /// and it needs nothing said anywhere about a block arrived at from outside.
2922 ///
2923 /// # What the allocator is told
2924 ///
2925 /// That every register it hands out is gone at the end of the first block. That is what makes
2926 /// the rest of the function right on the way back: control arrives from a `__builtin_longjmp`
2927 /// in some other function, and the only two registers that puts back are the stack pointer and
2928 /// the frame pointer, so anything this function still wants has to be in the frame those two
2929 /// reach. It is said with a write of every one of those registers, which is the same thing a
2930 /// call says about the registers a callee may destroy, on an instruction with nothing else on
2931 /// it so that the stores above are not caught up in it.
2932 fn saves_place(&mut self, inst: Inst) -> Result<(), Unsupported> {
2933 let data = &self.source[inst];
2934 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
2935 let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
2936 let span = self.source.span(inst);
2937 let buf = self.reg_of(buffer)?;
2938 let at = self.at.expect("a block is being filled");
2939 let gpr = self.gpr;
2940 let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
2941 let store = self.named(moves.store);
2942 let load = self.named(moves.load);
2943 let lea = self.named(self.selector.frame.lea);
2944 let put = self.named(self.selector.frame.imm);
2945 let nothing =
2946 self.selector.frame.pad.expect("a target with an instruction that does nothing");
2947 let nothing = self.named(nothing);
2948 self.stack.saves_place = true;
2949 let answer = self.answer_slot();
2950 let back = self.out.create_block();
2951
2952 // The zero this answers with, into the word a restore writes a one into.
2953 let zero = self.out.new_vreg(gpr);
2954 self.out.build(at, put).at(span).def(zero, gpr).imm(0).finish();
2955 let mem = self.frame_mem();
2956 let made = self.out.build(at, store).at(span).uses(zero, gpr).mem(mem).finish();
2957 self.stack.addresses.push((made, answer));
2958
2959 // The four words: where that word is, where control comes back to, and the two registers
2960 // the restore puts back.
2961 let found = self.frame_address(at, answer);
2962 self.write_word(at, span, store, found, buf, JUMP_ANSWER);
2963 let pc = self.out.new_vreg(gpr);
2964 self.out.build(at, lea).at(span).def(pc, gpr).mem(mir::Mem::block(back)).finish();
2965 self.write_word(at, span, store, pc, buf, JUMP_PC);
2966 let frame = mir::Reg::physical(self.conv.frame_pointer);
2967 self.write_word(at, span, store, frame, buf, JUMP_FRAME);
2968 let stack = mir::Reg::physical(self.conv.stack_pointer);
2969 self.write_word(at, span, store, stack, buf, JUMP_STACK);
2970
2971 // Nothing is in a register past this point, which is what the rest of the function is
2972 // allowed to assume about the way back in.
2973 let gone = self.across_jump();
2974 let mut build = self.out.build(at, nothing).at(span);
2975 for (reg, class) in gone {
2976 build = build.operand(mir::Operand::write(reg, class));
2977 }
2978 build.finish();
2979
2980 // And the rest of the block, which is the block the address above was of.
2981 *self.out.succs_mut(at) = vec![mir::BlockCall::to(back)];
2982 self.at = Some(back);
2983 let reg = self.new_reg(result);
2984 let mem = self.frame_mem();
2985 let made = self.out.build(back, load).at(span).def(reg, gpr).mem(mem).finish();
2986 self.stack.addresses.push((made, answer));
2987 Ok(())
2988 }
2989
2990 /// `__builtin_longjmp`, which reads a buffer a `__builtin_setjmp` filled in and goes there.
2991 ///
2992 /// Everything comes out of the buffer before anything is put back, and the four registers it
2993 /// comes out into are physical ones rather than values the allocator places. Both of those are
2994 /// about the same moment. The stack pointer is one of the things being put back, a value the
2995 /// allocator sent to the stack is reached through the stack pointer, and between the
2996 /// instruction that moves it and the jump there is no stack this function owns any more. A
2997 /// register named outright is a register nothing reloads into and nothing else is in, which is
2998 /// the only way to hold something across that moment.
2999 ///
3000 /// Four of them because that is how many things are in the air at once: where to go, the frame
3001 /// pointer to put back, the one the matching save is to answer with, and one register used
3002 /// twice, first for the address that one is written through and then for the stack pointer.
3003 ///
3004 /// Nothing after this in the block is reached. The marker is not a terminator, for the reason
3005 /// `spec/08-ir.md` gives, so the block goes on and whatever the front end wrote after it is
3006 /// written out and never run.
3007 fn comes_back(&mut self, inst: Inst) -> Result<(), Unsupported> {
3008 let data = &self.source[inst];
3009 let &buffer = self.source[data.args].first().ok_or_else(|| self.unsupported(inst))?;
3010 let span = self.source.span(inst);
3011 let buf = self.reg_of(buffer)?;
3012 let at = self.at.expect("a block is being filled");
3013 let gpr = self.gpr;
3014 let moves = self.selector.frame.moves(gpr).expect("a class the target says how to move");
3015 let load = self.named(moves.load);
3016 let store = self.named(moves.store);
3017 let mov = self.named(moves.mov);
3018 let put = self.named(self.selector.frame.imm);
3019 let jump = self.named(self.selector.branch.indirect);
3020
3021 let held = self.jump_regs();
3022 if held.len() < JUMP_REGS {
3023 return Err(self.unsupported(inst));
3024 }
3025 let pc = mir::Reg::physical(held[0]);
3026 let frame = mir::Reg::physical(held[1]);
3027 let spare = mir::Reg::physical(held[2]);
3028 let one = mir::Reg::physical(held[3]);
3029
3030 self.read_word(at, span, load, pc, buf, JUMP_PC);
3031 self.read_word(at, span, load, frame, buf, JUMP_FRAME);
3032 self.read_word(at, span, load, spare, buf, JUMP_ANSWER);
3033
3034 // What the matching save answers with, written through the address that came out of the
3035 // buffer, because the word it goes in is in the other function's frame and this one has no
3036 // way of knowing where that is.
3037 self.out.build(at, put).at(span).def(one, gpr).imm(1).finish();
3038 let mem = mir::Mem::at(mir::Operand::read(spare, gpr));
3039 self.out.build(at, store).at(span).uses(one, gpr).mem(mem).finish();
3040
3041 // The stack last of the four, so that the register the buffer is reached through is done
3042 // with before the stack it may have been spilled to stops being this function's.
3043 self.read_word(at, span, load, spare, buf, JUMP_STACK);
3044 let stack = mir::Reg::physical(self.conv.stack_pointer);
3045 self.copy(at, span, mov, stack, spare);
3046 let base = mir::Reg::physical(self.conv.frame_pointer);
3047 self.copy(at, span, mov, base, frame);
3048
3049 // And the jump, which reads the two registers just put back as well as the address it
3050 // goes through. Neither of those is printed, because the target's spelling of an indirect
3051 // jump has one argument and it is the first one read. They are there because the code
3052 // control arrives at reaches its frame through them, and because without them the two
3053 // instructions above write registers nothing reads: a scheduler is then free to put the
3054 // jump in front of them, and at `-O2` it does.
3055 self.out
3056 .build(at, jump)
3057 .at(span)
3058 .operand(mir::Operand::read(pc, gpr))
3059 .operand(mir::Operand::read(stack, gpr))
3060 .operand(mir::Operand::read(base, gpr))
3061 .finish();
3062 Ok(())
3063 }
3064
3065 /// One word of the buffer of a `__builtin_setjmp`, written from a register.
3066 fn write_word(
3067 &mut self,
3068 at: mir::Block,
3069 span: Span,
3070 store: mir::Opcode,
3071 from: mir::Reg,
3072 buf: mir::Reg,
3073 word: i32,
3074 ) {
3075 let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3076 self.out.build(at, store).at(span).uses(from, self.gpr).mem(mem).finish();
3077 }
3078
3079 /// One word of that buffer, read back into a register.
3080 fn read_word(
3081 &mut self,
3082 at: mir::Block,
3083 span: Span,
3084 load: mir::Opcode,
3085 into: mir::Reg,
3086 buf: mir::Reg,
3087 word: i32,
3088 ) {
3089 let mem = mir::Mem::at(mir::Operand::read(buf, self.gpr)).plus(word);
3090 self.out.build(at, load).at(span).def(into, self.gpr).mem(mem).finish();
3091 }
3092
3093 /// One register into another, which is the one shape of instruction the builder has no word
3094 /// for because neither operand is a definition of a value or a read of memory.
3095 fn copy(
3096 &mut self,
3097 at: mir::Block,
3098 span: Span,
3099 mov: mir::Opcode,
3100 into: mir::Reg,
3101 from: mir::Reg,
3102 ) {
3103 self.out
3104 .build(at, mov)
3105 .at(span)
3106 .operand(mir::Operand::write(into, self.gpr))
3107 .operand(mir::Operand::read(from, self.gpr))
3108 .finish();
3109 }
3110
3111 /// The word a `__builtin_setjmp` in this function answers with, asked for once and kept.
3112 fn answer_slot(&mut self) -> usize {
3113 match self.answer {
3114 Some(index) => index,
3115 None => {
3116 let index = self.stack.locals.len();
3117 self.stack.locals.push(Local { size: JUMP_WORD, align: JUMP_WORD });
3118 self.answer = Some(index);
3119 index
3120 }
3121 }
3122 }
3123
3124 /// An address in this function's frame with nothing in its displacement, which is what an
3125 /// instruction reaching one of its stack objects is written with until [`crate::finish`] knows
3126 /// where the object is.
3127 fn frame_mem(&self) -> mir::Mem {
3128 mir::Mem::at(mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr))
3129 }
3130
3131 /// Every register the allocator hands out, which is what a `__builtin_setjmp` destroys.
3132 ///
3133 /// Both files, since a `double` live across a save has the same problem an integer does. The
3134 /// two registers a frame is reached through are not here: the restore puts both of them back,
3135 /// which is the whole of what it puts back, and a function whose frame pointer was destroyed
3136 /// by its own save would have nothing left to find its caller with.
3137 fn across_jump(&self) -> Vec<(mir::Reg, RegClass)> {
3138 let mut gone = Vec::new();
3139 for ® in self.conv.int_order {
3140 if reg == self.conv.stack_pointer || reg == self.conv.frame_pointer {
3141 continue;
3142 }
3143 gone.push((mir::Reg::physical(reg), self.gpr));
3144 }
3145 for ® in self.conv.sse_order {
3146 gone.push((mir::Reg::physical(reg), self.conv.sse_class));
3147 }
3148 gone
3149 }
3150
3151 /// The registers a `__builtin_longjmp` may hold things in while it puts a frame back.
3152 ///
3153 /// The ones the allocator hands out, less the two a frame is reached through. The scratch
3154 /// registers are not among them on purpose: the rewriter writes a reload into one of those
3155 /// wherever it likes, and one of these has to survive from the load that fills it to the
3156 /// instruction that reads it however many instructions apart those are.
3157 fn jump_regs(&self) -> Vec<PhysReg> {
3158 self.conv
3159 .int_order
3160 .iter()
3161 .copied()
3162 .filter(|®| {
3163 reg != self.conv.stack_pointer
3164 && reg != self.conv.frame_pointer
3165 && !self.selector.scratch.contains(®)
3166 })
3167 .collect()
3168 }
3169
3170 /// A machine opcode of this target from the name the target gives it.
3171 fn named(&mut self, name: &str) -> mir::Opcode {
3172 mir::Opcode::new(self.names.intern(&format!("{}{name}", self.selector.prefix())))
3173 }
3174
3175 /// `__builtin_frame_address` and `__builtin_return_address`, which are a walk up the chain of
3176 /// saved frame pointers and then one thing read at the end of it.
3177 ///
3178 /// Every frame that kept a frame pointer holds the caller's at the address the register points
3179 /// at, and the address that frame returns to one word above that, which is where the call
3180 /// instruction put it and where the prologue's push left it. So the walk is a load through the
3181 /// register for each link, the frame address is wherever the walk stopped, and the return
3182 /// address is one more load from a word above it. gcc 16.2.0 writes exactly this, measured on
3183 /// x86-64 at `-O2` for depths zero to three of both builtins.
3184 ///
3185 /// The function is given a frame pointer because of this, which is what [`Stack::walks_frames`]
3186 /// carries out to the layout. A depth of zero needs it as the answer and every depth above zero
3187 /// needs it as the start, so there is no case here where it is not wanted.
3188 ///
3189 /// How far the chain actually reaches is the program's business and not this one's. A caller
3190 /// compiled without a frame pointer has no link in it for the walk to follow, so a depth above
3191 /// zero is a promise about how the whole program was built. That is why gcc documents a nonzero
3192 /// depth as unsafe rather than as an answer, and why the depth is refused above a limit in
3193 /// `check/builtin/frame.rs` rather than walked as far as it says.
3194 fn frames(&mut self, inst: Inst) -> Result<(), Unsupported> {
3195 let data = &self.source[inst];
3196 let Extra::Depth(depth) = data.extra else { return Err(self.unsupported(inst)) };
3197 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3198 let returning = data.opcode == Opcode::ReturnAddress;
3199 let block = self.at.expect("a block is being filled");
3200 let span = self.source.span(inst);
3201 let moves =
3202 self.selector.frame.moves(self.gpr).expect("a class the target says how to move");
3203 let load = self.named(moves.load);
3204 self.stack.walks_frames = true;
3205
3206 // Where the walk is up to. The frame pointer to begin with, and the register the last load
3207 // wrote after that.
3208 let reg = self.new_reg(result);
3209 let mut base = mir::Reg::physical(self.conv.frame_pointer);
3210 for link in 0..depth {
3211 // The last load of a walk that is looking for a frame writes the answer itself, which
3212 // is what keeps a walk of so many links that many instructions and not one more.
3213 let ends_here = link + 1 == depth && !returning;
3214 let next = if ends_here { reg } else { self.out.new_vreg(self.gpr) };
3215 let at = mir::Mem::at(mir::Operand::read(base, self.gpr));
3216 self.out.build(block, load).at(span).def(next, self.gpr).mem(at).finish();
3217 base = next;
3218 }
3219
3220 if returning {
3221 let up = i32::try_from(self.conv.return_address).expect("a word above the frame");
3222 let at = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
3223 self.out.build(block, load).at(span).def(reg, self.gpr).mem(at).finish();
3224 } else if depth == 0 {
3225 // The one case with no load in it at all: the frame this function is running in is the
3226 // register itself, and a physical register is not one the allocator hands out, so the
3227 // answer is a copy of it.
3228 let mov = self.named(moves.mov);
3229 self.out
3230 .build(block, mov)
3231 .at(span)
3232 .operand(mir::Operand::write(reg, self.gpr))
3233 .operand(mir::Operand::read(base, self.gpr))
3234 .finish();
3235 }
3236 Ok(())
3237 }
3238
3239 /// `__builtin_thread_pointer`, which is the front of the block [`Self::thread_address`] adds
3240 /// an offset to.
3241 ///
3242 /// The same one instruction, on its own this time and with nothing to add to it. A program
3243 /// writes this when what it wants is a number that is different in every thread and cheap to
3244 /// come by, rather than a variable of its own in the block, so there is no relocation here and
3245 /// no name for the link to resolve.
3246 fn thread_pointer(&mut self, inst: Inst) -> Result<(), Unsupported> {
3247 self.threads_written(inst)?;
3248 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3249 let block = self.at.expect("a block is being filled");
3250 let span = self.source.span(inst);
3251 let reg = self.new_reg(result);
3252 self.read_thread_pointer(block, span, reg);
3253 Ok(())
3254 }
3255
3256 /// What a named machine register holds, which is `register long x asm ("rbx");`.
3257 ///
3258 /// One move out of that register, with the register named as itself the way a register a
3259 /// template wrote is named, which is [`Self::itself`] and is the thing #1653 built. What it
3260 /// buys here is what it buys there: the register is part of the instruction the allocator
3261 /// sees, so it is a use the allocator will not have written over first, and the value goes
3262 /// into an ordinary one of its own that everything downstream reads.
3263 ///
3264 /// The whole sixty four bits are moved whatever the type is, because the register is that
3265 /// wide and a narrower type reads the low end of the copy, which is the same low end. A type
3266 /// wider than the register is refused, since there is no register holding it to read. On
3267 /// AArch64 a float may be kept in a vector register, `register double x asm ("d8");`, and it is
3268 /// moved out of that file the same way.
3269 ///
3270 /// A name the machine has not got is refused too, and is the only thing that can be wrong
3271 /// with the string: which register a name means is this machine's question and this is where
3272 /// the question is asked, at the same table `asm` asks about clobbers at. The sigil gcc
3273 /// allows in front of it is taken off here, because what the name is written with is syntax.
3274 fn register_value(&mut self, inst: Inst) -> Result<(), Unsupported> {
3275 let Extra::Symbol(symbol) = self.source[inst].extra else {
3276 return Err(self.unsupported(inst));
3277 };
3278 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3279 let ty = self.source[result].ty;
3280 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3281 if bits > ADDRESS_BITS {
3282 return Err(self.unsupported(inst));
3283 }
3284 let spelled = self.names.resolve(symbol).to_owned();
3285 let bare = spelled.strip_prefix('%').unwrap_or(&spelled);
3286 let named = if self.on_aarch64() {
3287 aarch64::named(bare)
3288 } else if self.class_of(ty) != self.gpr {
3289 return Err(self.unsupported(inst));
3290 } else {
3291 x86_64::gpr_named(bare).map(|(reg, _)| (reg, self.gpr))
3292 };
3293 let Some((held, file)) = named else {
3294 return Err(Unsupported::Register { inst, name: spelled });
3295 };
3296 // A float in a general purpose register, or a number in a vector one, is a register the
3297 // machine has holding a type that is not kept there, and would need a move between the
3298 // files that nothing here makes yet.
3299 if on_x87(ty) || self.class_of(ty) != file {
3300 return Err(self.unsupported(inst));
3301 }
3302 let block = self.at.expect("a block is being filled");
3303 let span = self.source.span(inst);
3304 let mov = self.selector.frame.moves(file).expect("a class the target says how to move").mov;
3305 let mov = self.named(mov);
3306 let into = self.new_reg(result);
3307 self.out
3308 .build(block, mov)
3309 .at(span)
3310 .operand(mir::Operand::write(into, file))
3311 .operand(
3312 mir::Operand::read(mir::Reg::physical(held), file).with(Constraint::Fixed(held)),
3313 )
3314 .finish();
3315 Ok(())
3316 }
3317
3318 /// A conversion that converts nothing: the result is the operand under another type.
3319 ///
3320 /// `ptrtoint` and `inttoptr` at one width are the whole of this. An address on this machine is
3321 /// an integer as wide as the machine addresses, so a cast between the two changes what the
3322 /// type system calls the value and changes nothing about the value, and the register holding
3323 /// it is the register that already held it. The front end never writes either of them at any
3324 /// other width, because it widens or narrows around the cast rather than through it, so the
3325 /// two widths disagreeing here means the IR came from somewhere else and is refused rather
3326 /// than guessed at.
3327 ///
3328 /// Reading the operand first is what materializes it when it is a constant, which is the case
3329 /// that matters: a null pointer is an `inttoptr` of zero, and that zero has to reach a
3330 /// register before anything can call it an address.
3331 fn rename(&mut self, inst: Inst) -> Result<(), Unsupported> {
3332 let data = &self.source[inst];
3333 let [arg] = self.source[data.args] else { return Err(self.unsupported(inst)) };
3334 let result = data.first_result.ok_or_else(|| self.unsupported(inst))?;
3335 if !self.is_address_width(self.source[arg].ty)
3336 || !self.is_address_width(self.source[result].ty)
3337 {
3338 return Err(self.unsupported(inst));
3339 }
3340 let reg = self.reg_of(arg)?;
3341 self.regs[result.index()] = Some(reg);
3342 Ok(())
3343 }
3344
3345 /// One barrier, which on this machine is one instruction at the strongest ordering and no
3346 /// instruction at all at every other one.
3347 ///
3348 /// x86-64 is total store order, so the only reordering the machine does is a store followed by
3349 /// a load of a different address, and the only ordering that forbids that is sequential
3350 /// consistency. An acquire, a release and an acquire release fence are therefore already true
3351 /// of every program running here, and what a program wanted from writing one is that the
3352 /// compiler not move memory accesses across it. The optimizer has finished by the time this
3353 /// runs and nothing below reorders one access past another, so the constraint is already
3354 /// discharged and there is nothing to write.
3355 ///
3356 /// The strongest one is `mfence`, which is what gcc 16.2.0 writes for
3357 /// `__atomic_thread_fence(__ATOMIC_SEQ_CST)` and for `__sync_synchronize`. A locked instruction
3358 /// on the stack is faster on most parts and is what some compilers write instead; it is also a
3359 /// write to memory the program did not ask for, and the plain barrier is the one that says what
3360 /// it means.
3361 ///
3362 /// Written here by name rather than by a rule, for the same reason a `lea` of a symbol is:
3363 /// there is nothing in a barrier that a proof over bitvectors could discharge. It computes
3364 /// nothing, so there is no equality to state, and what makes it the right answer is the memory
3365 /// model, which the rule language cannot talk about.
3366 fn barrier(&mut self, inst: Inst) -> Result<(), Unsupported> {
3367 let Extra::Order(order) = self.source[inst].extra else {
3368 return Err(self.unsupported(inst));
3369 };
3370 // AArch64 is not total store order, so every ordering above relaxed is an instruction
3371 // there. An acquire fence only has to keep later accesses after earlier loads, which is
3372 // `dmb ishld`, and everything stronger is the full `dmb ish` gcc writes for it.
3373 let name = match order {
3374 MemOrder::NotAtomic | MemOrder::Relaxed => return Ok(()),
3375 MemOrder::Acquire if self.on_aarch64() => "fence_acquire",
3376 _ if self.on_aarch64() => self.selector.fence,
3377 MemOrder::SeqCst => self.selector.fence,
3378 _ => return Ok(()),
3379 };
3380 let block = self.at.expect("a block is being filled");
3381 let span = self.source.span(inst);
3382 let fence = self.named(name);
3383 self.out.build(block, fence).at(span).finish();
3384 Ok(())
3385 }
3386
3387 /// The instruction a program stops on, which is one byte pair and no operands.
3388 ///
3389 /// `ud2` is an opcode the manual promises will never be given a meaning, so a processor that
3390 /// reaches it raises the fault for an instruction it does not know, and on Linux that arrives
3391 /// at the program as `SIGILL`. That is what `__builtin_trap` is for: a stop that cannot be
3392 /// caught by anything the program installed for an ordinary error, cannot be returned from,
3393 /// and leaves the address of the fault in the core file.
3394 ///
3395 /// Why not a call to `abort`. It is two bytes against a call and a relocation, it needs no
3396 /// library, and it works in the places this one is written most, which are a kernel and a
3397 /// freestanding program that has no `abort` to call. gcc 16.2.0 writes `ud2` here too.
3398 fn trap(&mut self, inst: Inst) {
3399 let block = self.at.expect("a block is being filled");
3400 let span = self.source.span(inst);
3401 let stop = self.named(self.selector.trap);
3402 self.out.build(block, stop).at(span).finish();
3403 }
3404
3405 /// One hint that an address is about to be used, which is one instruction and no promise.
3406 ///
3407 /// Four instructions on this machine and the locality picks between them, which is what the
3408 /// number means: how much of the data will still be wanted after the access. None of it wanted
3409 /// is `prefetchnta`, which brings the line in without keeping it, and all of it wanted is
3410 /// `prefetcht0`, which brings it as close as the machine can. The two in between are the levels
3411 /// between those. Measured against gcc 16.2.0 on x86-64 rather than read off the manual: zero
3412 /// gives `prefetchnta`, one `prefetcht2`, two `prefetcht1` and three `prefetcht0`.
3413 ///
3414 /// Whether the access will write is not read on x86-64, and that is the machine rather than an
3415 /// omission. The write hint is `prefetchw`, which is not in the base instruction set, and gcc
3416 /// writes it only when the command line said the part has it. So a prefetch for a write is the
3417 /// same instruction as a prefetch for a read, which is what gcc 16.2.0 writes without
3418 /// `-mprfchw`. AArch64 has it in the base set, so there a write picks the four `pst` forms of
3419 /// `prfm` in place of the `pld` ones, at the same levels.
3420 ///
3421 /// The address goes in the addressing mode rather than in an operand, the way a store's does.
3422 /// It is built here as the plainest one there is, a register and nothing else, because what
3423 /// arrives is a value and folding an addition into the mode is a rule's job and no rule reaches
3424 /// this instruction. An address the program computed is therefore one `lea` or one add in front
3425 /// of this, which is what it would have been for the load the hint is about anyway.
3426 fn hint(&mut self, inst: Inst) -> Result<(), Unsupported> {
3427 let Extra::Prefetch(hint) = self.source[inst].extra else {
3428 return Err(self.unsupported(inst));
3429 };
3430 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3431 let [address] = args[..] else { return Err(self.unsupported(inst)) };
3432 // AArch64 has the write hint in the base instruction set, and gcc 16.2.0 writes it there.
3433 let write = hint.write && self.on_aarch64();
3434 let name = match (hint.locality, write) {
3435 (0, false) => "prefetch_nta",
3436 (1, false) => "prefetch_t2",
3437 (2, false) => "prefetch_t1",
3438 (PrefetchHint::MOST, false) => "prefetch_t0",
3439 (0, true) => "prefetch_w_nta",
3440 (1, true) => "prefetch_w_t2",
3441 (2, true) => "prefetch_w_t1",
3442 (PrefetchHint::MOST, true) => "prefetch_w_t0",
3443 // Nothing else exists. The checker reads a locality outside the range as zero and the
3444 // verifier refuses one that got here another way, so this is a hint that was built
3445 // rather than checked, and the safe answer for a hint is to write no instruction.
3446 _ => return Err(self.unsupported(inst)),
3447 };
3448 let base = self.reg_of(address)?;
3449 let block = self.at.expect("a block is being filled");
3450 let opcode = self.named(name);
3451 self.out
3452 .build(block, opcode)
3453 .at(self.source.span(inst))
3454 .mem(mir::Mem::at(mir::Operand::read(base, self.gpr)))
3455 .finish();
3456 Ok(())
3457 }
3458
3459 /// One compare and exchange, which is the instruction every other atomic on this machine is
3460 /// built out of.
3461 ///
3462 /// What the IR asks for is: read what is at an address, compare it against a value the program
3463 /// expected, put a second value there if the two were equal, and say both what was read and
3464 /// whether the exchange happened. The machine has exactly that instruction, and the `lock` in
3465 /// front of it is what makes the whole of it one step as far as every other processor is
3466 /// concerned.
3467 ///
3468 /// The ordering is not read here, and that is the memory model rather than an omission. A
3469 /// locked instruction on x86-64 is a full barrier whatever the program asked for, so a relaxed
3470 /// compare and exchange and a sequentially consistent one are the same instruction, and there
3471 /// is nothing weaker to emit for the weaker orderings. The failure ordering is not read for the
3472 /// same reason.
3473 ///
3474 /// The two values it produces are why this is written by name. The one the program compares
3475 /// against and the one it gets back are both `rax`, which the instruction reads and writes
3476 /// without being told, and the table says so with a fixed constraint at each end rather than
3477 /// leaving the allocator to find out. The second value is the byte behind it, which is the zero
3478 /// flag read out by a `sete`, and it is a definition of the same instruction so that the
3479 /// allocator knows the two are live together and never gives the byte the register the answer
3480 /// is in.
3481 fn exchange(&mut self, inst: Inst) -> Result<(), Unsupported> {
3482 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3483 let results: Vec<Value> = self.source[inst].results().collect();
3484 let [addr, expected, desired] = args[..] else { return Err(self.unsupported(inst)) };
3485 let [old, exchanged] = results[..] else { return Err(self.unsupported(inst)) };
3486 if self.on_aarch64() {
3487 return self.exchange_a64(inst, [addr, expected, desired], [old, exchanged]);
3488 }
3489
3490 // A value the machine can compare in one instruction, which is an integer or an address at
3491 // one of the four widths it has a compare and exchange for. Anything else is a type this
3492 // has no instruction for rather than a program that is wrong, and the front end refuses it
3493 // before ever getting here.
3494 let ty = self.source[old].ty;
3495 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3496 if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3497 return Err(self.unsupported(inst));
3498 }
3499
3500 let base = self.reg_of(addr)?;
3501 let want = self.reg_of(expected)?;
3502 let put = self.reg_of(desired)?;
3503 let got = self.new_reg(old);
3504 let flag = self.new_reg(exchanged);
3505
3506 let name = format!("cmpxchg_{bits}");
3507 let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3508 let block = self.at.expect("a block is being filled");
3509 let opcode = self.named(&name);
3510 let (span, flags) = (self.source.span(inst), self.carried(inst));
3511 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3512 for (desc, reg) in descs.iter().zip([got, flag, want, put]) {
3513 let operand = mir::Operand {
3514 reg,
3515 class: desc.class,
3516 role: desc.role,
3517 constraint: desc.constraint,
3518 };
3519 build = build.operand(operand);
3520 }
3521 build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3522 Ok(())
3523 }
3524
3525 /// One read modify write, for the three operations this machine does in a single instruction.
3526 ///
3527 /// What the IR asks for is: read what is at an address, do something to it, put the answer back,
3528 /// say what was there before, and let nothing get between the three steps. The machine has
3529 /// `xchg` for putting a value there and `lock xadd` for adding one, and both leave what they
3530 /// found in the register the operand arrived in, which is why the value that comes back and the
3531 /// value that went in are one register here.
3532 ///
3533 /// A subtraction is the add over the negated operand, which is right at every width because the
3534 /// machine's arithmetic wraps and negating then adding is subtracting in two's complement
3535 /// whatever the operands were. The negate is a separate instruction in front, over a register of
3536 /// its own, so that the value the program handed over is not the one written on: an operand may
3537 /// be live after this and a program that read it again would read the negation.
3538 ///
3539 /// The ordering is not read, for the reason the compare and exchange beside this does not read
3540 /// it. `xchg` with memory locks the bus whether it is asked to or not and `lock xadd` is asked
3541 /// to, so both are full barriers on this machine and there is nothing weaker to fall to.
3542 ///
3543 /// Eight of the other ten never arrive, because `crate::retry` turned each of them into a loop
3544 /// around a compare and exchange before anything here saw it. The two that do arrive are the
3545 /// ones on floating values, and they are refused: a compare and exchange of a float wants the
3546 /// value carried through an integer of the same width, and an eighty bit float has no such
3547 /// width. Neither family of builtins can write one yet either, so a program that reaches this
3548 /// refusal is a program that reached an unimplemented builtin first.
3549 fn modify(&mut self, inst: Inst) -> Result<(), Unsupported> {
3550 let Extra::Rmw(op, _) = self.source[inst].extra else {
3551 return Err(self.unsupported(inst));
3552 };
3553 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3554 let [addr, operand] = args[..] else { return Err(self.unsupported(inst)) };
3555 let old = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3556
3557 // A value the machine can exchange in one instruction, which is an integer at one of the
3558 // four widths it has these for. A pointer arrives as an address, so it is an integer by the
3559 // time it is here, and anything else is a type this has no instruction for.
3560 let ty = self.source[old].ty;
3561 if !ty.is_int() || !matches!(ty.bits(), 8 | 16 | 32 | 64) {
3562 return Err(self.unsupported(inst));
3563 }
3564 if self.on_aarch64() {
3565 return self.modify_a64(inst, op, [addr, operand], old);
3566 }
3567 let name = match op {
3568 RmwOp::Xchg => format!("xchg_{}", ty.bits()),
3569 RmwOp::Add | RmwOp::Sub => format!("xadd_{}", ty.bits()),
3570 _ => return Err(self.unsupported(inst)),
3571 };
3572
3573 let base = self.reg_of(addr)?;
3574 let mut put = self.reg_of(operand)?;
3575 let block = self.at.expect("a block is being filled");
3576 let span = self.source.span(inst);
3577 if op == RmwOp::Sub {
3578 let negated = self.out.new_vreg(self.gpr);
3579 let negate = self.named(&format!("neg_r_{}", ty.bits()));
3580 let descs = self
3581 .selector
3582 .operands(&format!("neg_r_{}", ty.bits()))
3583 .ok_or_else(|| self.unsupported(inst))?;
3584 let mut build = self.out.build(block, negate).at(span);
3585 for (desc, reg) in descs.iter().zip([negated, put]) {
3586 build = build.operand(mir::Operand {
3587 reg,
3588 class: desc.class,
3589 role: desc.role,
3590 constraint: desc.constraint,
3591 });
3592 }
3593 build.finish();
3594 put = negated;
3595 }
3596
3597 let got = self.new_reg(old);
3598 let descs = self.selector.operands(&name).ok_or_else(|| self.unsupported(inst))?;
3599 let opcode = self.named(&name);
3600 let flags = self.carried(inst);
3601 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3602 for (desc, reg) in descs.iter().zip([got, put]) {
3603 build = build.operand(mir::Operand {
3604 reg,
3605 class: desc.class,
3606 role: desc.role,
3607 constraint: desc.constraint,
3608 });
3609 }
3610 build.mem(mir::Mem::at(mir::Operand::read(base, self.gpr))).finish();
3611 Ok(())
3612 }
3613
3614 /// The width an AArch64 atomic works at, which is an integer or an address of one of the four
3615 /// widths the exclusive loads and stores have. Anything else is refused.
3616 fn atomic_bits(&self, inst: Inst, ty: Type) -> Result<u32, Unsupported> {
3617 let bits = if ty.is_ptr() { ADDRESS_BITS } else { ty.bits() };
3618 if (!ty.is_int() && !ty.is_ptr()) || !matches!(bits, 8 | 16 | 32 | 64) {
3619 return Err(self.unsupported(inst));
3620 }
3621 Ok(bits)
3622 }
3623
3624 /// One instruction by name, with its operands in the order the table lists them.
3625 fn written_as(&mut self, inst: Inst, name: &str, regs: &[mir::Reg]) -> Result<(), Unsupported> {
3626 let descs = self.selector.operands(name).ok_or_else(|| self.unsupported(inst))?;
3627 if descs.len() != regs.len() {
3628 return Err(self.unsupported(inst));
3629 }
3630 let block = self.at.expect("a block is being filled");
3631 let opcode = self.named(name);
3632 let (span, flags) = (self.source.span(inst), self.carried(inst));
3633 let mut build = self.out.build(block, opcode).at(span).flags(flags);
3634 for (desc, ®) in descs.iter().zip(regs) {
3635 build = build.operand(mir::Operand {
3636 reg,
3637 class: desc.class,
3638 role: desc.role,
3639 constraint: desc.constraint,
3640 });
3641 }
3642 build.finish();
3643 Ok(())
3644 }
3645
3646 /// An acquiring load or a releasing store on AArch64, which is `ldar` or `stlr`.
3647 ///
3648 /// Only a relaxed access became the plain one above this, so what arrives is acquire or
3649 /// stronger for a load and release or stronger for a store. `ldar` and `stlr` are also
3650 /// sequentially consistent with each other, which is why the strongest ordering needs no fence
3651 /// on either side, and is what gcc 16.2.0 writes for all of them.
3652 fn ordered(&mut self, inst: Inst) -> Result<(), Unsupported> {
3653 let args: Vec<Value> = self.source[self.source[inst].args].to_vec();
3654 if self.source[inst].opcode == Opcode::AtomicLoad {
3655 let [addr] = args[..] else { return Err(self.unsupported(inst)) };
3656 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
3657 let bits = self.atomic_bits(inst, self.source[result].ty)?;
3658 let base = self.reg_of(addr)?;
3659 let got = self.new_reg(result);
3660 return self.written_as(inst, &format!("ldar_{bits}"), &[got, base]);
3661 }
3662 let [value, addr] = args[..] else { return Err(self.unsupported(inst)) };
3663 let bits = self.atomic_bits(inst, self.source[value].ty)?;
3664 let put = self.reg_of(value)?;
3665 let base = self.reg_of(addr)?;
3666 self.written_as(inst, &format!("stlr_{bits}"), &[put, base])
3667 }
3668
3669 /// A compare and exchange on AArch64, which is a loop of an exclusive load and store.
3670 ///
3671 /// The loop is one instruction as far as everything below is concerned, so that nothing can
3672 /// be spilled or reloaded between the two exclusive accesses, which would lose the reservation
3673 /// on some parts every time. Its definitions are all early, since they are written before the
3674 /// last read. The acquiring and releasing forms are used whatever the ordering, which is what
3675 /// gcc writes at the strongest one and is never wrong at a weaker one. The yes or no comes out
3676 /// of the status register the store wrote, read as a flag after the loop.
3677 fn exchange_a64(
3678 &mut self,
3679 inst: Inst,
3680 [addr, expected, desired]: [Value; 3],
3681 [old, exchanged]: [Value; 2],
3682 ) -> Result<(), Unsupported> {
3683 let bits = self.atomic_bits(inst, self.source[old].ty)?;
3684 let base = self.reg_of(addr)?;
3685 let want = self.reg_of(expected)?;
3686 let put = self.reg_of(desired)?;
3687 let got = self.new_reg(old);
3688 let flag = self.new_reg(exchanged);
3689 self.written_as(inst, &format!("cmpxchg_{bits}"), &[got, flag, base, want, put])
3690 }
3691
3692 /// A read modify write on AArch64, for the three operations that reach here, each a loop of
3693 /// an exclusive load and store for the reason the compare and exchange above is.
3694 fn modify_a64(
3695 &mut self,
3696 inst: Inst,
3697 op: RmwOp,
3698 [addr, operand]: [Value; 2],
3699 old: Value,
3700 ) -> Result<(), Unsupported> {
3701 let bits = self.atomic_bits(inst, self.source[old].ty)?;
3702 let base = self.reg_of(addr)?;
3703 let put = self.reg_of(operand)?;
3704 let got = self.new_reg(old);
3705 let status = self.out.new_vreg(self.gpr);
3706 match op {
3707 RmwOp::Xchg => {
3708 self.written_as(inst, &format!("xchg_{bits}"), &[got, status, base, put])
3709 }
3710 RmwOp::Add | RmwOp::Sub => {
3711 let name = if op == RmwOp::Add { "xadd" } else { "xsub" };
3712 let new = self.out.new_vreg(self.gpr);
3713 self.written_as(inst, &format!("{name}_{bits}"), &[got, new, status, base, put])
3714 }
3715 _ => Err(self.unsupported(inst)),
3716 }
3717 }
3718
3719 /// One `asm` statement.
3720 ///
3721 /// An empty template is most of the inline assembly in a test suite, and it is not a corner
3722 /// case somebody wrote by accident. A program that wants a value computed where it stands, or a
3723 /// loop the optimizer must not touch, writes `asm volatile ("" : : : "memory")`, and forty
3724 /// years of bug reports about optimizers are full of them. What such a statement asks for is
3725 /// the barrier and the operand places, and no instructions at all.
3726 ///
3727 /// So the operands are the half that is always real: a constraint says where a value has to be,
3728 /// and where it has to be is still true when the template between them is empty.
3729 ///
3730 /// What the constraints ask for, on an empty template, is only ever that two operands share a
3731 /// place. Nothing reads a register no text names, so `"r"` on its own asks for a register and
3732 /// no particular one, and any register at all answers it. A matching constraint is different,
3733 /// because it says the output the assembly leaves is the place the input arrived in, and with
3734 /// no instructions between them that is the input unchanged. So it is a rename and not a move:
3735 /// the value is already in a register and the result is that register.
3736 ///
3737 /// An output nothing is tied to and no instruction writes is whatever the assembly left there,
3738 /// which for a template that writes nothing is whatever was in the register. That is a value
3739 /// the program is not entitled to, and this writes a zero rather than reading one, because the
3740 /// allocator has to be given a definition before a use whatever the program is entitled to.
3741 ///
3742 /// # A template with instructions in it
3743 ///
3744 /// [`x86_64::read`] turns the text into the opcodes this backend already has, which is what
3745 /// `spec/11-asm-objects-debug.md` section 11.1 asks for: the machine is described once, and an
3746 /// instruction a program wrote is looked up in that description rather than copied through to
3747 /// an assembler that has one of its own. So nothing here assembles anything. What it does is
3748 /// put the statement's operands where the opcode holds them, and from there an `asm` statement
3749 /// is ordinary machine code: the allocator picks the registers, the listing and the object file
3750 /// are written from the same table as every other instruction, and a spill around one works
3751 /// because there is nothing left about it for a spill to get wrong.
3752 ///
3753 /// A register the template named in its own text is the one thing in there that is nobody's
3754 /// operand, and it is placed as itself. See [`Self::itself`] for why that is safer here than
3755 /// the thing gcc does, which is to copy the name out and leave the allocator none the wiser.
3756 ///
3757 /// Two things are refused, both for one reason, which is that placing them by a guess gives a
3758 /// program that assembles into something other than what it says.
3759 ///
3760 /// An output the template writes more than once, which is one place with two definitions in it,
3761 /// and the machine IR between here and the allocator has one definition per register by
3762 /// construction. An output tied to an input and written once is not that: it is two registers
3763 /// the description ties together, which is what [`Place`] is about.
3764 ///
3765 /// An operand read where the opcode writes, or written where it reads. An output that has not
3766 /// been written yet is not a value, and an input the assembly writes over is a value something
3767 /// else may still be using.
3768 ///
3769 /// # A register the instruction uses without being told
3770 ///
3771 /// An instruction may reach a register its text does not name, and `cpuid` is all of them at
3772 /// once: the leaf goes in `eax`, the subleaf in `ecx`, and the answer comes back in all four
3773 /// registers. The description holds every bit of that already, so what is left is to say which
3774 /// of the statement's operands is in each of those registers, and the constraint letter is the
3775 /// one thing in an assembly statement that says it. `"=a"` is an output in `rax` and `"c"` is
3776 /// an input in `rcx`, which is why a program writing `cpuid` writes its constraints that way
3777 /// and has no choice about it.
3778 ///
3779 /// A register no letter named is one the statement put nothing in, and that is the usual case
3780 /// rather than an unusual one, since an instruction that answers four questions is written by
3781 /// programs that asked one. A write of one is the register being destroyed and gets a register
3782 /// of its own, which is what tells the allocator to keep everything else out of it. A read of
3783 /// one is a register the instruction looks at and the program never filled, which gets a zero
3784 /// for the reason [`Self::undefined`] gives.
3785 ///
3786 /// # The clobber list
3787 ///
3788 /// Read now, as the registers it names being written by every instruction of the template. By
3789 /// every one rather than by one of them, because the list says the assembly as a whole leaves
3790 /// them ruined and nothing here knows which line did it. Every entry has to be a register this
3791 /// machine has a name for or the statement is refused, since a name nobody read is a register
3792 /// nobody is keeping out of.
3793 ///
3794 /// `memory` and `cc` are the two entries that are not registers and both are skipped. `memory`
3795 /// says the assembly touches storage, which is already true of every `asm` this writes and is
3796 /// nothing a register list could hold. `cc` says it ruins the condition flags, and the flag
3797 /// tracking already has that from the instructions the template was read into, since it takes
3798 /// every instruction it does not recognize as writing them and every instruction here is one
3799 /// this machine describes. `flags` is the name gcc's own register table gives the same thing on
3800 /// this machine, so a program writing it has written `cc` and is read that way: tcc's
3801 /// `tests/tcctest.c` lists both on one statement.
3802 ///
3803 /// A clobber the instruction already writes is left off it. `cpuid` writes all four registers
3804 /// by description, and a statement listing three of them as clobbers as well is saying the
3805 /// same thing twice, which the allocator would read as one register with two definitions.
3806 ///
3807 /// On a template with nothing in it the list is ignored, as it was before, since a template
3808 /// with no instructions ruins nothing whatever it said about what it ruins.
3809 fn assembly(&mut self, inst: Inst) -> Result<(), Unsupported> {
3810 let data = &self.source[inst];
3811 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
3812 let info = self.source[asm];
3813 if !self.source[info.targets].is_empty() {
3814 return Err(Unsupported::Assembly { inst, refused: Written::Goto });
3815 }
3816 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
3817
3818 let constraints = self.names.resolve(info.constraints).to_string();
3819 let results: Vec<Value> = data.results().collect();
3820 let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
3821 .ok_or_else(refused)?;
3822 let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
3823
3824 // Read after the constraints and not before them, because a mnemonic whose suffix the
3825 // program left off is read at the width of the operands it names, and the operands are
3826 // what the constraints are a list of.
3827 let widths: Vec<Option<x86_64::Width>> = list
3828 .iter()
3829 .map(|operand| {
3830 let ty = self.source[operand.result.or(operand.value)?].ty;
3831 if !ty.is_scalar() {
3832 return None;
3833 }
3834 x86_64::Width::of_bits(held_bits(ty))
3835 })
3836 .collect();
3837 // An operand in memory is an address the statement holds and an object the template names,
3838 // so the reader is told which ones those are and spells `%0` for one as the object.
3839 let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
3840 let template = self.names.resolve(info.template).to_string();
3841 let steps = if template.trim().is_empty() {
3842 Vec::new()
3843 } else {
3844 match x86_64::read_in(&template, &widths, &memory) {
3845 Some(steps) => steps,
3846 None => return self.kept(inst, &template, &list, &widths, &memory),
3847 }
3848 };
3849
3850 // Which operands the template writes, counted before anything is placed, because the answer
3851 // decides where each of the three below comes from and one instruction may name an operand
3852 // that a later one writes. Which of them any instruction puts in a register at all is
3853 // counted in the same walk, since an operand no instruction reaches that way is one nothing
3854 // has to put anywhere: a constant a template names only as the distance into an address is
3855 // written into the instruction, and a register holding a copy of it would be one nobody
3856 // reads. An operand the address is counted from is reached that way and is counted here for
3857 // that reason, because the walk below it is over the opcode's operands and an address is
3858 // not one of those.
3859 //
3860 // Whether any instruction reads an operand an instruction above it wrote is counted in the
3861 // same walk too. Such a template is one whose instructions have to be written in order with
3862 // each read taken from wherever the last write left the operand, which is what
3863 // [`Self::woven`] does, and so is one that writes an operand twice.
3864 let mut writes = vec![0usize; list.len()];
3865 let mut reads = vec![false; list.len()];
3866 let mut held = vec![false; list.len()];
3867 let mut after = false;
3868 for step in &steps {
3869 // A call out of the template writes every register the convention lets the callee
3870 // leave anything in, and an output pinned to one of those is written by it.
3871 if let x86_64::Step::Call { .. } = step {
3872 for index in self.lost(&list).into_iter().filter_map(|(_, _, index)| index) {
3873 *writes.get_mut(index).ok_or_else(refused)? += 1;
3874 }
3875 continue;
3876 }
3877 let x86_64::Step::Line(line) = step else { continue };
3878 match line.at.and_then(|at| at.base) {
3879 Some(x86_64::Piece::Operand { index, .. }) => {
3880 *held.get_mut(index).ok_or_else(refused)? = true;
3881 after |= writes[index] > 0;
3882 }
3883 Some(x86_64::Piece::Reg { reg, .. }) => {
3884 if let Some(index) = bound(&list, reg, Role::Use) {
3885 *held.get_mut(index).ok_or_else(refused)? = true;
3886 after |= writes[index] > 0;
3887 }
3888 }
3889 _ => {}
3890 }
3891 let mut written = Vec::new();
3892 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
3893 // Which registers the instruction reaches, asked the same way it is asked again when
3894 // the instruction is written. See [`Self::lettered`] for the one opcode whose answer
3895 // comes from the constraint letters rather than from the description.
3896 let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(&list));
3897 let (described, pieces) = match &lettered {
3898 Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
3899 None => (form.operands(), line.operands.as_slice()),
3900 };
3901 for (desc, piece) in described.iter().zip(pieces) {
3902 // An operand the instruction reaches without its text saying so is the statement's
3903 // only when a constraint letter put something there. One that is nobody's writes
3904 // nothing of the program's, so it is counted nowhere and is dealt with where it is
3905 // placed.
3906 let index = match *piece {
3907 x86_64::Piece::Operand { index, .. } => index,
3908 x86_64::Piece::Implicit { reg } => match bound(&list, reg, desc.role) {
3909 Some(index) => index,
3910 None => continue,
3911 },
3912 x86_64::Piece::Reg { reg, .. } => match bound(&list, reg, desc.role) {
3913 Some(index) => index,
3914 None => continue,
3915 },
3916 };
3917 *held.get_mut(index).ok_or_else(refused)? = true;
3918 if matches!(desc.role, Role::Def | Role::EarlyDef) {
3919 written.push(index);
3920 } else {
3921 *reads.get_mut(index).ok_or_else(refused)? = true;
3922 after |= writes[index] > 0;
3923 }
3924 }
3925 for index in written {
3926 *writes.get_mut(index).ok_or_else(refused)? += 1;
3927 }
3928 }
3929 let woven = after
3930 || writes.iter().any(|&count| count > 1)
3931 || steps.iter().any(|step| !matches!(step, x86_64::Step::Line(_)));
3932
3933 // Where every operand is. Worked out in full before the first instruction is written, since
3934 // reading a value may be what puts it in a register in the first place, and that has to
3935 // happen in front of the assembly rather than in the middle of it.
3936 let mut places: Vec<Place> = vec![Place::default(); list.len()];
3937 for (index, operand) in list.iter().copied().enumerate() {
3938 let Some(result) = operand.result else {
3939 // An input, or an output the assembly was handed the address of, and both are a
3940 // value that arrives in a register and is read out of it, unless no instruction of
3941 // the template reads it out of one.
3942 let value = operand.value.ok_or_else(refused)?;
3943 if held[index] {
3944 places[index].read = Some(self.reg_of(value)?);
3945 }
3946 continue;
3947 };
3948 let ty = self.source[result].ty;
3949 if on_x87(ty) {
3950 return Err(refused());
3951 }
3952 let tied = operands.tied_to(index);
3953 if let Some(from) = tied {
3954 if self.class_of(self.source[from].ty) != self.class_of(ty) {
3955 return Err(refused());
3956 }
3957 places[index].read = Some(self.reg_of(from)?);
3958 }
3959 if writes[index] > 0 {
3960 places[index].write = Some(self.new_reg(result));
3961 continue;
3962 }
3963 match tied {
3964 // The place the input arrived in, which the assembly wrote nothing over. One
3965 // register, so this is a rename rather than a move.
3966 Some(_) => {
3967 let reg = places[index].read.ok_or_else(refused)?;
3968 self.regs[result.index()] = Some(reg);
3969 places[index].write = Some(reg);
3970 }
3971 None => {
3972 self.undefined(inst, result)?;
3973 places[index].write = self.regs[result.index()];
3974 }
3975 }
3976 }
3977
3978 // An output an instruction of the template also reads, which the statement said nothing
3979 // about because an output is what a statement says the other thing about. What it holds
3980 // there is undefined, and a program writing one means it: `sbb %0, %0` in libgmp's
3981 // `add_mssaaaa` subtracts a register from itself and is asking for the borrow bit rather
3982 // than for the number, so whatever the register held, the answer is the same. Undefined is
3983 // not the same as absent though, since the allocator is owed a definition in front of every
3984 // use, so it gets the zero an output nothing wrote gets and for the same reason.
3985 //
3986 // Unless an input could have been in the same register, in which case gcc's allocator puts
3987 // it there whenever it can and a program may have been written against that. tcc's test of
3988 // a call from a template reads its output `"=a" (s)` to pass `"r" (str)` to `getenv`, which
3989 // is only the string because gcc gave the two of them `rax`. So an output nothing has
3990 // written yet reads the one input that could share its place, when there is exactly one.
3991 // One written `&` is written before the inputs are read and shares nothing.
3992 for index in 0..list.len() {
3993 if !reads[index] || places[index].read.is_some() || places[index].write.is_none() {
3994 continue;
3995 }
3996 let reg = match self.shared(&list, index) {
3997 Some(value) => self.reg_of(value)?,
3998 None => self.seeded(inst, list[index])?,
3999 };
4000 places[index].read = Some(reg);
4001 }
4002
4003 // Worked out once for the whole template, since the list is one list and every instruction
4004 // of the template gets it. Not worked out at all for a template with no instructions, which
4005 // is where there is nothing for it to go on.
4006 let clobbers = self.names.resolve(info.clobbers).to_string();
4007 let clobbered =
4008 if steps.is_empty() { Vec::new() } else { Self::clobbered(inst, &clobbers)? };
4009
4010 // A template with a label in it is not one run of instructions, and what it is instead is
4011 // in [`Self::woven`], which is also where a template goes whose instructions read what the
4012 // ones above them wrote. Every other template is what it has always been, which is every
4013 // instruction of it written into the block the statement stands in.
4014 if woven {
4015 return self.woven(inst, &steps, &mut places, &list, &clobbered, &writes);
4016 }
4017 for step in &steps {
4018 let x86_64::Step::Line(line) = step else { continue };
4019 self.instruction(inst, line, &places, &list, &clobbered)?;
4020 }
4021 Ok(())
4022 }
4023
4024 /// A template the reader could not take apart, kept as its text. See [`x86_64::Form::Template`].
4025 ///
4026 /// What the text names is spelled into it here, the way gcc prints it into its listing: a
4027 /// constant as `$5`, or as `5` under the `c` modifier, and the address of a name as the name.
4028 /// An object in memory is the one thing that cannot be spelled yet, since where it is depends on
4029 /// registers nothing has chosen, so it is left as a hole the writer fills and its address is the
4030 /// instruction's memory operand. One is all an instruction has room for, and every template this
4031 /// has met names one at most. A template that names an operand by name rather than by number is
4032 /// refused for now.
4033 ///
4034 /// # An operand in a register
4035 ///
4036 /// Which register is not known until the allocator has run, and the text is written down before
4037 /// then, so an operand in a register is a hole too. It names the instruction's own operand and
4038 /// the width the modifier asked for, or the width of the operand's type when there was none,
4039 /// and the writer spells whatever register the operand ended up in. What the text writes goes
4040 /// in first as definitions and what it reads goes in last as uses, with the registers below in
4041 /// between, so the allocator sees the statement as one instruction with every operand said. An
4042 /// output tied to an input, by `+` or by a number, reuses the input's register, and one written
4043 /// `&` is written early. Anything wider than a general purpose register is refused.
4044 ///
4045 /// A statement written with no colons is basic assembly, where `%` is a character like any
4046 /// other and a register is written `%eax`. The front end keeps no mark of which kind a statement
4047 /// was, so one with no operands and no clobbers is read as basic, which is what gcc would do for
4048 /// every such template but one written with empty colons around it.
4049 ///
4050 /// The registers a call may write are taken as written, see below for why.
4051 fn kept(
4052 &mut self,
4053 inst: Inst,
4054 template: &str,
4055 list: &[AsmOperand<'_>],
4056 widths: &[Option<x86_64::Width>],
4057 memory: &[bool],
4058 ) -> Result<(), Unsupported> {
4059 // Refused as the template it is, since keeping it is what was tried after reading it
4060 // failed, and what could not be kept is what it names rather than any one operand.
4061 let refused = || Unsupported::Assembly { inst, refused: Written::Template };
4062 let data = &self.source[inst];
4063 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4064 let clobbers = self.names.resolve(self.source[asm].clobbers).to_string();
4065 let basic = list.is_empty() && clobbers.trim().is_empty();
4066
4067 // Every register a call may leave anything in, as well as the ones the list names. The
4068 // text can write any register it likes without saying so, and tcc's tests do: gcc gets
4069 // away with that at `-O0` because nothing lives in a register between two statements
4070 // there, and taking these away from the allocator across the template is what gives the
4071 // same answer here. Nothing is written to them by this, so a register one template leaves
4072 // a value in is still holding it when the next template reads it.
4073 let a64 = self.on_aarch64();
4074 let mut clobbered: Vec<(PhysReg, RegClass)> =
4075 self.lost(list).into_iter().map(|(reg, class, _)| (reg, class)).collect();
4076 let named = if a64 {
4077 Self::clobbered_a64(inst, &clobbers)?
4078 } else {
4079 Self::clobbered(inst, &clobbers)?.into_iter().map(|reg| (reg, self.gpr)).collect()
4080 };
4081 for &(reg, class) in &named {
4082 if !clobbered.iter().any(|&(had, of)| had == reg && of == class) {
4083 clobbered.push((reg, class));
4084 }
4085 }
4086
4087 // The file each operand is in. On AArch64 `w` is a floating point or vector register and an
4088 // input tied to an output is in that output's file. A value whose type puts it in the other
4089 // file would need a move into this one first, which gcc makes and this does not yet, so
4090 // that is refused below.
4091 let mut files = vec![self.gpr; list.len()];
4092 if a64 {
4093 let constraints = self.names.resolve(self.source[asm].constraints);
4094 for (file, entry) in files.iter_mut().zip(constraints.split(',')) {
4095 if vector_letter(entry) {
4096 *file = self.conv.sse_class;
4097 }
4098 }
4099 for index in 0..list.len() {
4100 if let Some(&file) = list[index].tied.and_then(|output| files.get(output)) {
4101 files[index] = file;
4102 }
4103 }
4104 }
4105 let pins: Vec<_> = list.iter().map(|operand| self.pinned_here(operand)).collect();
4106 let pin = |index: usize, file: RegClass| match pins[index] {
4107 Some((at, class)) if class == file => Ok(Some(Constraint::Fixed(at))),
4108 Some(_) => Err(refused()),
4109 None => Ok(None),
4110 };
4111
4112 // The operands in a register, as the instruction's own. An input the text is handed as a
4113 // constant or as the address of a name is spelled into the text instead, when its
4114 // constraint allows a constant at all and no output is tied to it. `"a" (0x1234)` is a
4115 // register holding the number, the way gcc loads it, since the text may ask for `%h0`.
4116 let mut defs: Vec<mir::Operand> = Vec::new();
4117 let mut uses: Vec<mir::Operand> = Vec::new();
4118 let mut def_of: Vec<Option<usize>> = vec![None; list.len()];
4119 let mut use_of: Vec<Option<usize>> = vec![None; list.len()];
4120 if !basic {
4121 for (index, operand) in list.iter().enumerate() {
4122 let Some(result) = operand.result else { continue };
4123 let (ty, file) = (self.source[result].ty, files[index]);
4124 if on_x87(ty) || self.class_of(ty) != file {
4125 return Err(refused());
4126 }
4127 let reg = self.new_reg(result);
4128 let written = if operand.early {
4129 mir::Operand::write_early(reg, file)
4130 } else {
4131 mir::Operand::write(reg, file)
4132 };
4133 def_of[index] = Some(defs.len());
4134 defs.push(match pin(index, file)? {
4135 Some(fixed) => written.with(fixed),
4136 None => written,
4137 });
4138 }
4139 for (index, operand) in list.iter().enumerate() {
4140 let Some(value) = operand.value else { continue };
4141 let spelled = operand.result.is_none()
4142 && operand.tied.is_none()
4143 && operand.immediate
4144 && (self.number(value).is_some() || self.named_address(value).is_some());
4145 // An operand in memory is spelled on AArch64 as the register its address is in,
4146 // which is `[x3]` and is an address every instruction that takes one reads.
4147 if (operand.memory && !a64) || spelled {
4148 continue;
4149 }
4150 let (ty, file) = (self.source[value].ty, files[index]);
4151 if on_x87(ty) || self.class_of(ty) != file {
4152 return Err(refused());
4153 }
4154 let read = mir::Operand::read(self.reg_of(value)?, file);
4155 use_of[index] = Some(uses.len());
4156 uses.push(match pin(index, file)? {
4157 Some(fixed) => read.with(fixed),
4158 None => read,
4159 });
4160 }
4161 }
4162 // Every register a call may write is more than a template can give up when it has more
4163 // operands in registers than the convention keeps across a call. `sodium_sub` in
4164 // libsodium's `utils.c` is one: eight outputs written early and two inputs pinned, against
4165 // the five registers SysV preserves, so an output has nowhere to go and nothing is left to
4166 // carry one to its slot either. gcc gives that template ten registers, and a program that
4167 // writes a register it did not name is only owed what gcc would have done, which here is
4168 // one of the ten. So the registers taken as written without being named are handed back,
4169 // from the end of the convention's order, until the operands fit in what is left. One the
4170 // list names or an operand is pinned to stays where it is.
4171 let fixed_to: Vec<PhysReg> = defs
4172 .iter()
4173 .chain(&uses)
4174 .filter_map(|operand| match operand.constraint {
4175 Constraint::Fixed(at) => Some(at),
4176 _ => None,
4177 })
4178 .collect();
4179 let wanted = defs.iter().chain(&uses).count() - fixed_to.len();
4180 let int = self.conv.int_class;
4181 let free = |clobbered: &[(PhysReg, RegClass)]| {
4182 self.conv
4183 .int_order
4184 .iter()
4185 .filter(|&®| !fixed_to.contains(®) && !clobbered.contains(&(reg, int)))
4186 .count()
4187 };
4188 while free(&clobbered) < wanted {
4189 let Some(at) = clobbered.iter().rposition(|&(reg, class)| {
4190 class == int && !named.contains(&(reg, class)) && !fixed_to.contains(®)
4191 }) else {
4192 break;
4193 };
4194 clobbered.remove(at);
4195 }
4196
4197 // A register an output is pinned to is that output's definition and not a clobber as well.
4198 // One an input is pinned to is written as the instruction finishes, the way a call writes
4199 // the register its argument came in, and every other one is written early, since the text
4200 // may write it before it has read its inputs and an input must not be in it.
4201 let mut written: Vec<mir::Operand> = Vec::new();
4202 for (reg, class) in clobbered {
4203 let fixed = |operand: &mir::Operand| {
4204 operand.class == class && operand.constraint == Constraint::Fixed(reg)
4205 };
4206 if defs.iter().any(fixed) {
4207 continue;
4208 }
4209 let reg = mir::Reg::physical(reg);
4210 written.push(if uses.iter().any(fixed) {
4211 mir::Operand::write(reg, class)
4212 } else {
4213 mir::Operand::write_early(reg, class)
4214 });
4215 }
4216 // An output tied to an input is one register, which the definition says by reusing the
4217 // use, or by both being fixed to the same one when the output was pinned.
4218 let first_use = defs.len() + written.len();
4219 for (output, operand) in list.iter().enumerate() {
4220 let Some(def) = def_of[output] else { continue };
4221 let input = if operand.value.is_some() {
4222 Some(output)
4223 } else {
4224 list.iter().position(|entry| entry.tied == Some(output))
4225 };
4226 let Some(read) = input.and_then(|input| use_of[input]) else { continue };
4227 match defs[def].constraint {
4228 Constraint::Fixed(_) => uses[read].constraint = defs[def].constraint,
4229 _ => {
4230 let at = u8::try_from(first_use + read).map_err(|_| refused())?;
4231 defs[def].constraint = Constraint::Reuse(at);
4232 }
4233 }
4234 }
4235
4236 // A line naming an operand in a register, with an instruction on it the reader knows, is
4237 // one the reader refused for a reason of its own, and keeping it as text would hand the
4238 // assembler what the reader already said no to. `addq %1, %k0` is that: a quadword add
4239 // into half a register. What is kept is a line with an instruction nothing here knows.
4240 let registered = |index: usize| def_of[index].is_some() || use_of[index].is_some();
4241 if !a64 && (0..list.len()).any(registered) {
4242 for line in template.split(['\n', ';']) {
4243 if names_one(line, registered)
4244 && x86_64::known(line, widths, memory)
4245 && x86_64::read_in(line, widths, memory).is_none()
4246 {
4247 return Err(refused());
4248 }
4249 }
4250 }
4251
4252 let mut text = String::with_capacity(template.len());
4253 let mut memory: Option<usize> = None;
4254 if basic {
4255 text.push_str(template);
4256 } else {
4257 let mut chars = template.chars().peekable();
4258 // Inside `{att|intel}`, and past the `|` in it, which is the half nobody reads. AArch64
4259 // has one dialect, and a brace there is a list of vector registers.
4260 let mut dialect = false;
4261 let mut skipped = false;
4262 while let Some(c) = chars.next() {
4263 match c {
4264 '{' if !a64 => {
4265 dialect = true;
4266 continue;
4267 }
4268 '|' if dialect => {
4269 skipped = true;
4270 continue;
4271 }
4272 '}' if dialect => {
4273 dialect = false;
4274 skipped = false;
4275 continue;
4276 }
4277 _ if skipped => continue,
4278 '%' => {}
4279 _ => {
4280 text.push(c);
4281 continue;
4282 }
4283 }
4284 match chars.peek().copied() {
4285 Some(c @ ('%' | '{' | '|' | '}')) => {
4286 chars.next();
4287 text.push(c);
4288 continue;
4289 }
4290 Some('=') => {
4291 chars.next();
4292 text.push_str(&inst.index().to_string());
4293 continue;
4294 }
4295 _ => {}
4296 }
4297 let modifier = match chars.peek().copied() {
4298 Some(c) if c.is_ascii_alphabetic() => {
4299 chars.next();
4300 Some(c)
4301 }
4302 _ => None,
4303 };
4304 let mut digits = String::new();
4305 while let Some(c) = chars.peek().copied().filter(char::is_ascii_digit) {
4306 digits.push(c);
4307 chars.next();
4308 }
4309 let index: usize = digits.parse().map_err(|_| refused())?;
4310 let operand = list.get(index).ok_or_else(refused)?;
4311 if operand.memory && a64 {
4312 let at = use_of[index].map(|at| first_use + at).ok_or_else(refused)?;
4313 if modifier.is_some() {
4314 return Err(refused());
4315 }
4316 text.push('[');
4317 text.push_str(&template_reg(at, 'x'));
4318 text.push(']');
4319 continue;
4320 }
4321 if operand.memory {
4322 if modifier.is_some() || memory.is_some_and(|had| had != index) {
4323 return Err(refused());
4324 }
4325 memory = Some(index);
4326 text.push_str(x86_64::TEMPLATE_MEM);
4327 continue;
4328 }
4329 let placed = def_of[index].or(use_of[index].map(|at| first_use + at));
4330 if let Some(at) = placed {
4331 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4332 let bits = held_bits(self.source[value].ty);
4333 // `w` and `x` are the two names every general purpose register has, and one
4334 // with no modifier is named at the width of its type, as gcc names it. A
4335 // vector register with no modifier is `v`, which is what gcc writes for one
4336 // whatever is in it, and the modifiers name the scalar views of it.
4337 let width = if a64 && files[index] != self.gpr {
4338 match modifier {
4339 None => 'v',
4340 Some(view @ ('b' | 'h' | 's' | 'd' | 'q')) => view,
4341 Some(_) => return Err(refused()),
4342 }
4343 } else if a64 {
4344 match (modifier, bits) {
4345 (None, 8 | 16 | 32) | (Some('w'), _) => 'w',
4346 (None, 64) | (Some('x'), _) => 'x',
4347 _ => return Err(refused()),
4348 }
4349 } else {
4350 match modifier {
4351 None => match held_bits(self.source[value].ty) {
4352 8 => 'b',
4353 16 => 'w',
4354 32 => 'k',
4355 64 => 'q',
4356 _ => return Err(refused()),
4357 },
4358 Some(width @ ('b' | 'w' | 'k' | 'q')) => width,
4359 // The second byte is a name only four registers have, so it is taken for
4360 // an operand pinned to one of them and for nothing the allocator chose.
4361 Some('h') if pinned(operand).and_then(x86_64::gpr_high).is_some() => {
4362 'h'
4363 }
4364 Some(_) => return Err(refused()),
4365 }
4366 };
4367 text.push_str(&template_reg(at, width));
4368 continue;
4369 }
4370 let value = operand.value.ok_or_else(refused)?;
4371 let bare = match modifier {
4372 None => false,
4373 Some('c' | 'P' | 'p') => true,
4374 Some(_) => return Err(refused()),
4375 };
4376 // A constant is bare on AArch64 whatever the modifier, which is how gcc prints one
4377 // there and a form GNU as takes wherever `#` would go.
4378 if !bare && !a64 {
4379 text.push('$');
4380 }
4381 if let Some(number) = self.number(value) {
4382 text.push_str(&number.to_string());
4383 } else if let Some(symbol) = self.named_address(value) {
4384 text.push_str(&template_name(self.names.resolve(symbol)));
4385 } else {
4386 return Err(refused());
4387 }
4388 }
4389 }
4390
4391 // An object in this function's frame is named by where it is in the frame, the way gcc
4392 // names it, rather than by a register its address was put in first. The text may write
4393 // registers it does not declare, and tcc's tests do: one that writes `%ecx` behind the
4394 // compiler's back would otherwise take the address with it.
4395 let mut local = None;
4396 let at = match memory.filter(|_| !a64) {
4397 Some(index) => {
4398 let value = list[index].value.ok_or_else(refused)?;
4399 local = self.local_of(value);
4400 let base = match local {
4401 Some(_) => mir::Reg::physical(self.conv.stack_pointer),
4402 None => self.reg_of(value)?,
4403 };
4404 Some(mir::Mem::at(mir::Operand::read(base, self.gpr)))
4405 }
4406 None => None,
4407 };
4408 let symbol = self.names.intern(&text);
4409 let opcode = self.named(if a64 { aarch64::TEMPLATE } else { x86_64::TEMPLATE });
4410 let block = self.at.expect("a block is being filled");
4411 let span = self.source.span(inst);
4412 let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4413 for operand in defs.into_iter().chain(written).chain(uses) {
4414 build = build.operand(operand);
4415 }
4416 if let Some(mem) = at {
4417 build = build.mem(mem);
4418 }
4419 let made = build.finish();
4420 if let Some(local) = local {
4421 self.stack.addresses.push((made, local));
4422 }
4423 Ok(())
4424 }
4425
4426 /// The object in this function's frame a value is the address of, for one an `alloca` of a
4427 /// size known here made. See [`Self::reserve`], which is where the `lea` it is found by came
4428 /// from.
4429 fn local_of(&self, value: Value) -> Option<usize> {
4430 let Def::Result { inst, .. } = self.source[value].def else { return None };
4431 if self.source[inst].opcode != Opcode::Alloca
4432 || !self.source[self.source[inst].args].is_empty()
4433 {
4434 return None;
4435 }
4436 let reg = self.regs[value.index()]?;
4437 self.stack.addresses.iter().find_map(|&(made, local)| {
4438 let data = &self.out[made];
4439 let defined = self.out[data.operands].first()?;
4440 (defined.reg == reg).then_some(local)
4441 })
4442 }
4443
4444 /// The name a value is the address of, for one a `global_addr` defined.
4445 fn named_address(&self, value: Value) -> Option<Symbol> {
4446 let Def::Result { inst, .. } = self.source[value].def else { return None };
4447 if self.source[inst].opcode != Opcode::GlobalAddr {
4448 return None;
4449 }
4450 let Extra::Symbol(symbol) = self.source[inst].extra else { return None };
4451 Some(symbol)
4452 }
4453
4454 /// A register holding a zero, for an operand of a template that is read before anything filled
4455 /// it.
4456 ///
4457 /// Two things ask for this and they are the same thing twice. An output the template reads has
4458 /// nothing to be read out of until the instruction that writes it has run, and a loop carries
4459 /// an operand into a block before the instruction that fills it, so both are a use in front of
4460 /// every definition. What the program is owed there is nothing, since the value is undefined
4461 /// either way, and what the allocator is owed is a register something wrote.
4462 fn seeded(&mut self, inst: Inst, operand: AsmOperand<'_>) -> Result<mir::Reg, Unsupported> {
4463 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4464 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4465 let class = self.class_of(self.source[value].ty);
4466 if class != self.gpr {
4467 return Err(refused());
4468 }
4469 let block = self.at.expect("a block is being filled");
4470 let reg = self.out.new_vreg(class);
4471 let put = self.named("mov_ri_64");
4472 self.out.build(block, put).at(self.source.span(inst)).def(reg, class).imm(0).finish();
4473 Ok(reg)
4474 }
4475
4476 /// A template with labels in it, as the blocks its jumps leave and arrive at.
4477 ///
4478 /// A statement is an instruction of the IR and stands inside one block, so a template that
4479 /// jumps has to stop being one thing. Each label becomes a block, each jump ends the block it
4480 /// stands in and gives it two arms, and whatever follows the statement goes into whichever
4481 /// block the walk finished in, which is what [`Self::block`] already reads off `self.at` and
4482 /// what [`Self::saves_place`] already does for the same reason.
4483 ///
4484 /// # What is carried between them
4485 ///
4486 /// The machine IR here is in the form where a register is written once, so an operand written
4487 /// inside a loop and read again at the top of it cannot be one register. What arrives at the
4488 /// top is a parameter of that block, and every jump to it carries whichever register held the
4489 /// operand where the jump stands. That is the whole of the bookkeeping: every block a label
4490 /// made takes one parameter for each operand that is in a register at all, in one order, so an
4491 /// arm's arguments and a block's parameters are the same list read twice.
4492 ///
4493 /// Which register an operand is in at each point is kept in the read half of its place, since
4494 /// that is what the instructions below read it out of. An instruction that writes an operand
4495 /// leaves it in the register it wrote, and a jump below carries that one. The block an
4496 /// untaken jump falls into is arrived at one way only and so takes no parameters, and nothing
4497 /// about where the operands are changes there.
4498 ///
4499 /// An operand written by the template and filled by nothing is written as a zero first, for
4500 /// the reason [`Self::undefined`] gives and one more: a jump may carry it before the
4501 /// instruction that fills it has run, and an argument has to be a register something wrote.
4502 ///
4503 /// # The condition state
4504 ///
4505 /// Nothing carries it and nothing has to. The instruction that sets it and the jump that reads
4506 /// it are both written here, next to each other in one block, and what the allocator may put
4507 /// between them is a move, which on this machine leaves the condition state alone. The edge
4508 /// into a block a loop goes back to is a critical edge and `crate::split` gives it a block of
4509 /// its own, so the moves an arm turns into land behind the jump rather than in front of it.
4510 fn woven(
4511 &mut self,
4512 inst: Inst,
4513 steps: &[x86_64::Step],
4514 places: &mut [Place],
4515 list: &[AsmOperand<'_>],
4516 clobbered: &[PhysReg],
4517 writes: &[usize],
4518 ) -> Result<(), Unsupported> {
4519 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4520 let span = self.source.span(inst);
4521
4522 // Which operands are carried, which is every one that is in a register at all. An operand
4523 // the template never puts in one, such as a constant it names only as the distance into an
4524 // address, is in the instruction and has nowhere to be carried from.
4525 let mut carried: Vec<(usize, RegClass)> = Vec::new();
4526 for (index, operand) in list.iter().enumerate() {
4527 if places[index].read.is_none() && places[index].write.is_none() {
4528 continue;
4529 }
4530 let value = operand.result.or(operand.value).ok_or_else(refused)?;
4531 let ty = self.source[value].ty;
4532 if on_x87(ty) {
4533 return Err(refused());
4534 }
4535 carried.push((index, self.class_of(ty)));
4536 }
4537
4538 // What each of them holds where the template starts.
4539 for &(index, _) in &carried {
4540 if places[index].read.is_some() {
4541 continue;
4542 }
4543 if writes[index] == 0 {
4544 places[index].read = places[index].write;
4545 continue;
4546 }
4547 places[index].read = Some(self.seeded(inst, list[index])?);
4548 }
4549
4550 // The blocks, made before the walk because a jump forwards names a label the walk has not
4551 // reached yet.
4552 let mut labels: Vec<(&str, mir::Block, Vec<mir::Reg>)> = Vec::new();
4553 for step in steps {
4554 let x86_64::Step::Label(name) = step else { continue };
4555 let block = self.out.create_block();
4556 let mut params = Vec::with_capacity(carried.len());
4557 for &(_, class) in &carried {
4558 params.push(self.out.append_param(block, class));
4559 }
4560 labels.push((name.as_str(), block, params));
4561 }
4562
4563 let mut wrote: Vec<usize> = Vec::new();
4564 for step in steps {
4565 match step {
4566 x86_64::Step::Label(name) => {
4567 let (block, params) = Self::went(&labels, name).ok_or_else(refused)?;
4568 let from = self.at.expect("a block is being filled");
4569 let args = Self::held(places, &carried).ok_or_else(refused)?;
4570 *self.out.succs_mut(from) = vec![mir::BlockCall::with(block, args)];
4571 self.at = Some(block);
4572 for (at, &(index, _)) in carried.iter().enumerate() {
4573 places[index].read = params.get(at).copied();
4574 }
4575 }
4576 x86_64::Step::Jump { opcode, to } => {
4577 let (block, _) = Self::went(&labels, to).ok_or_else(refused)?;
4578 let from = self.at.expect("a block is being filled");
4579 let args = Self::held(places, &carried).ok_or_else(refused)?;
4580 let opcode = self.named(opcode);
4581 self.out.build(from, opcode).at(span).finish();
4582 let next = self.out.create_block();
4583 *self.out.succs_mut(from) =
4584 vec![mir::BlockCall::with(block, args), mir::BlockCall::to(next)];
4585 self.at = Some(next);
4586 }
4587 x86_64::Step::Away { symbol } => {
4588 // Only in a function that is written without a prologue, which is the one
4589 // place the jump means what it says. Anywhere else there is an epilogue behind
4590 // the statement that puts the registers back and gives the frame up, and a
4591 // jump over it goes to the next function with this function's frame still
4592 // taken. The reader already made sure it is the last step of the template, so
4593 // what is left to ask is about the function around it.
4594 if !self.source.attrs.set.contains(AttrSet::NAKED) {
4595 return Err(Unsupported::Assembly { inst, refused: Written::Away });
4596 }
4597 let from = self.at.expect("a block is being filled");
4598 let opcode = self.named(AWAY);
4599 let symbol = self.names.intern(symbol);
4600 self.out.build(from, opcode).at(span).symbol(symbol).finish();
4601 // Nowhere, which is what a jump out of the function leaves behind it and is
4602 // the same list a `ret` leaves. The block after it is made for the walk above
4603 // rather than for the program: the statement may be in the middle of a body
4604 // that goes on being lowered, and what that lowering writes is reached by
4605 // nothing and thrown away with the block.
4606 *self.out.succs_mut(from) = Vec::new();
4607 self.at = Some(self.out.create_block());
4608 }
4609 x86_64::Step::Call { symbol } => {
4610 self.call_out(inst, symbol, places, list, clobbered, &carried, &mut wrote)?;
4611 }
4612 x86_64::Step::Line(line) => {
4613 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4614 let mut written = Vec::new();
4615 for (desc, piece) in form.operands().iter().zip(&line.operands) {
4616 if !desc.role.is_def() {
4617 continue;
4618 }
4619 let index = match *piece {
4620 x86_64::Piece::Operand { index, .. } => index,
4621 x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
4622 Some(index) => index,
4623 None => continue,
4624 },
4625 x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
4626 Some(index) => index,
4627 None => continue,
4628 },
4629 };
4630 written.push(index);
4631 }
4632 // A register is written once in this form of the machine IR, so an operand
4633 // an instruction above already wrote is written into a new one here, and what
4634 // reads it below reads that one.
4635 for &index in &written {
4636 if !wrote.contains(&index) {
4637 wrote.push(index);
4638 continue;
4639 }
4640 let &(_, class) =
4641 carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4642 let place = places.get_mut(index).ok_or_else(refused)?;
4643 place.write = Some(self.out.new_vreg(class));
4644 }
4645 self.instruction(inst, line, places, list, clobbered)?;
4646 for index in written {
4647 let place = places.get_mut(index).ok_or_else(refused)?;
4648 if place.write.is_some() {
4649 place.read = place.write;
4650 }
4651 }
4652 }
4653 }
4654 }
4655
4656 // Where the walk left each output, which is the parameter of the block a label made when
4657 // the template ends in one and the register an instruction wrote when it does not.
4658 for (index, operand) in list.iter().enumerate() {
4659 let Some(result) = operand.result else { continue };
4660 if let Some(reg) = places[index].read {
4661 self.regs[result.index()] = Some(reg);
4662 }
4663 }
4664 Ok(())
4665 }
4666
4667 /// A template's call to a function somewhere else, as the call the convention makes.
4668 ///
4669 /// The opcode is the one a call written in C becomes, so everything that asks whether a
4670 /// function calls anything gets the answer it would for one: the stack pointer is left aligned
4671 /// at the statement and nothing is kept in the red zone. What is not the same is the operands.
4672 /// Nothing is passed by the convention, since the template put the arguments where it wanted
4673 /// them, and what comes back is whatever an output is pinned to, since that is the only thing
4674 /// the template says about it. Every other register the callee may leave anything in is
4675 /// written here, which is what a program that calls from a template never says and always
4676 /// means.
4677 #[allow(clippy::too_many_arguments)]
4678 fn call_out(
4679 &mut self,
4680 inst: Inst,
4681 symbol: &str,
4682 places: &mut [Place],
4683 list: &[AsmOperand<'_>],
4684 clobbered: &[PhysReg],
4685 carried: &[(usize, RegClass)],
4686 wrote: &mut Vec<usize>,
4687 ) -> Result<(), Unsupported> {
4688 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4689 let mut operands = Vec::new();
4690 let mut written = Vec::new();
4691 let lost = self.lost(list);
4692 for &(reg, class, index) in &lost {
4693 let Some(index) = index else {
4694 operands.push(mir::Operand::write(mir::Reg::physical(reg), class));
4695 continue;
4696 };
4697 // Written once in this form of the machine IR, so a second write is a new register,
4698 // the same as for an instruction in [`Self::woven`].
4699 if wrote.contains(&index) {
4700 let &(_, class) =
4701 carried.iter().find(|&&(at, _)| at == index).ok_or_else(refused)?;
4702 places.get_mut(index).ok_or_else(refused)?.write = Some(self.out.new_vreg(class));
4703 } else {
4704 wrote.push(index);
4705 }
4706 let place = places.get(index).ok_or_else(refused)?.write.ok_or_else(refused)?;
4707 operands.push(mir::Operand::write(place, class).with(Constraint::Fixed(reg)));
4708 written.push(index);
4709 }
4710 for ® in clobbered {
4711 if lost.iter().all(|&(gone, class, _)| gone != reg || class != self.gpr) {
4712 operands.push(mir::Operand::write(mir::Reg::physical(reg), self.gpr));
4713 }
4714 }
4715 let block = self.at.expect("a block is being filled");
4716 let span = self.source.span(inst);
4717 let opcode = mir::Opcode::new(self.names.intern(abi::CALL));
4718 let symbol = self.names.intern(symbol);
4719 let mut build = self.out.build(block, opcode).at(span).symbol(symbol);
4720 for operand in operands {
4721 build = build.operand(operand);
4722 }
4723 build.finish();
4724 let calls = &mut self.stack.calls;
4725 *calls = Some(calls.unwrap_or(0));
4726 for index in written {
4727 let place = places.get_mut(index).ok_or_else(refused)?;
4728 place.read = place.write;
4729 }
4730 Ok(())
4731 }
4732
4733 /// Every register a call may leave anything in, with its file and the output pinned to it if
4734 /// one is.
4735 ///
4736 /// A register is asked about with its file, since the two files are numbered from nought alike
4737 /// and a question about `v8` alone would find an output pinned to `x8`.
4738 fn lost(&self, list: &[AsmOperand<'_>]) -> Vec<(PhysReg, RegClass, Option<usize>)> {
4739 let conv = self.conv;
4740 let ints = conv.int_order.iter().filter(|&®| !conv.preserves_int(reg));
4741 let sses = conv.sse_order.iter().filter(|&®| !conv.preserves_sse(reg));
4742 let written = |reg, class| {
4743 list.iter().position(|operand| {
4744 operand.result.is_some() && self.pinned_here(operand) == Some((reg, class))
4745 })
4746 };
4747 ints.map(|®| (reg, conv.int_class, written(reg, conv.int_class)))
4748 .chain(sses.map(|®| (reg, conv.sse_class, written(reg, conv.sse_class))))
4749 .collect()
4750 }
4751
4752 /// The input an output read before anything wrote it shares its register with, which is the
4753 /// one input that could be in that register, or nothing when there is none or more than one.
4754 ///
4755 /// Could be means nothing ties it elsewhere: it is in a register rather than in memory, no
4756 /// constraint pins it anywhere the output is not, and it is not tied to another output. An
4757 /// output written `&` shares nothing, since the assembly writes it before it reads the inputs.
4758 fn shared(&self, list: &[AsmOperand<'_>], index: usize) -> Option<Value> {
4759 let output = list.get(index)?;
4760 if output.early || output.tied.is_some() {
4761 return None;
4762 }
4763 let class = self.class_of(self.source[output.result?].ty);
4764 let mut fits = list.iter().filter(|operand| {
4765 operand.result.is_none()
4766 && !operand.memory
4767 && operand.tied.is_none()
4768 && operand.value.is_some_and(|value| self.class_of(self.source[value].ty) == class)
4769 && pinned(operand).is_none_or(|reg| pinned(output) == Some(reg))
4770 });
4771 let value = fits.next()?.value;
4772 if fits.next().is_some() {
4773 return None;
4774 }
4775 value
4776 }
4777
4778 /// The block one of the template's labels made, and the parameters it takes.
4779 fn went<'b>(
4780 labels: &'b [(&str, mir::Block, Vec<mir::Reg>)],
4781 name: &str,
4782 ) -> Option<(mir::Block, &'b [mir::Reg])> {
4783 labels
4784 .iter()
4785 .find(|(had, ..)| *had == name)
4786 .map(|(_, block, params)| (*block, params.as_slice()))
4787 }
4788
4789 /// The register each carried operand is in, which is what an arm to a label carries.
4790 fn held(places: &[Place], carried: &[(usize, RegClass)]) -> Option<Vec<mir::Reg>> {
4791 carried.iter().map(|&(index, _)| places.get(index)?.read).collect()
4792 }
4793
4794 /// The registers a clobber list names, in the order it named them.
4795 ///
4796 /// Nothing is dropped. A name this has no register for is refused, because the list is the
4797 /// program telling the compiler which registers it may not leave anything in, and an entry
4798 /// nobody read is a register something may still be left in. See [`Self::assembly`] for the
4799 /// two entries that are not registers and for why they are skipped rather than refused.
4800 fn clobbered(inst: Inst, clobbers: &str) -> Result<Vec<PhysReg>, Unsupported> {
4801 let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
4802 let mut named = Vec::new();
4803 for entry in clobbers.split(',') {
4804 let entry = entry.trim().trim_matches('"');
4805 // The sigil is optional in a clobber list and means nothing when it is there, unlike
4806 // in a template, where it is what tells a register from an operand.
4807 let entry = entry.strip_prefix('%').unwrap_or(entry);
4808 if entry.is_empty() || matches!(entry, "memory" | "cc" | "flags") {
4809 continue;
4810 }
4811 let (reg, _) = x86_64::gpr_named(entry).ok_or_else(refused)?;
4812 if !named.contains(®) {
4813 named.push(reg);
4814 }
4815 }
4816 Ok(named)
4817 }
4818
4819 /// [`Self::clobbered`] on AArch64, where a clobber may name a vector register as well as a
4820 /// general purpose one, so each comes back with the file it is in. See [`aarch64::named`].
4821 fn clobbered_a64(inst: Inst, clobbers: &str) -> Result<Vec<(PhysReg, RegClass)>, Unsupported> {
4822 let refused = || Unsupported::Assembly { inst, refused: Written::Clobber };
4823 let mut named = Vec::new();
4824 for entry in clobbers.split(',') {
4825 let entry = entry.trim().trim_matches('"');
4826 if entry.is_empty() || matches!(entry, "memory" | "cc") {
4827 continue;
4828 }
4829 let reg = aarch64::named(entry).ok_or_else(refused)?;
4830 if !named.contains(®) {
4831 named.push(reg);
4832 }
4833 }
4834 Ok(named)
4835 }
4836
4837 /// Whether the machine being lowered for is AArch64.
4838 fn on_aarch64(&self) -> bool {
4839 std::ptr::eq(self.selector.shapes, &aarch64::MACHINE)
4840 }
4841
4842 /// The register an operand is pinned to on the machine being lowered for.
4843 ///
4844 /// [`pinned`] on x86, where it is always a general purpose register. AArch64 has no constraint
4845 /// letter for one register, so there only a local register variable pins anything, and its name
4846 /// is read against [`aarch64::named`], which may put it in either file. The file comes back with
4847 /// the register because the two are numbered from nought alike, and `x8` is not `v8`.
4848 fn pinned_here(&self, operand: &AsmOperand<'_>) -> Option<(PhysReg, RegClass)> {
4849 if !self.on_aarch64() {
4850 return pinned(operand).map(|reg| (reg, self.gpr));
4851 }
4852 let name = operand.named?;
4853 aarch64::named(name.strip_prefix('%').unwrap_or(name))
4854 }
4855
4856 /// An `asm` statement on AArch64, which is kept as text whatever is in it.
4857 ///
4858 /// Nothing reads AArch64 assembly back into instructions yet, so every template goes the way
4859 /// one the x86 reader could not take apart goes, which is [`Self::kept`]: the text is carried
4860 /// to the listing with a hole for each operand, and the operands are the instruction's own. A
4861 /// constraint with a letter whose meaning differs between the two machines is refused first.
4862 /// See [`shared_letters`].
4863 fn spelled(&mut self, inst: Inst) -> Result<(), Unsupported> {
4864 let data = &self.source[inst];
4865 let Extra::Asm(asm) = data.extra else { return Err(self.unsupported(inst)) };
4866 let info = self.source[asm];
4867 if !self.source[info.targets].is_empty() {
4868 return Err(Unsupported::Assembly { inst, refused: Written::Goto });
4869 }
4870 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4871 let constraints = self.names.resolve(info.constraints).to_string();
4872 if !constraints.split(',').all(shared_letters) {
4873 return Err(refused());
4874 }
4875 // `Q` is memory addressed by one register and nothing else, which is how every operand in
4876 // memory is spelled here already, so it is read as `m`. See [`shared_letters`].
4877 let constraints = letters_outside(&constraints, |c| if c == 'Q' { 'm' } else { c });
4878 let results: Vec<Value> = data.results().collect();
4879 let operands = AsmOperands::read(&constraints, &results, &self.source[data.args])
4880 .ok_or_else(refused)?;
4881 let list: Vec<AsmOperand<'_>> = operands.iter().copied().collect();
4882 let widths = vec![None; list.len()];
4883 let memory: Vec<bool> = list.iter().map(|operand| operand.memory).collect();
4884 let template = self.names.resolve(info.template).to_string();
4885 self.kept(inst, &template, &list, &widths, &memory)
4886 }
4887
4888 /// One instruction of a template, as the machine instruction it was read back into.
4889 fn instruction(
4890 &mut self,
4891 inst: Inst,
4892 line: &x86_64::Line,
4893 places: &[Place],
4894 list: &[AsmOperand<'_>],
4895 clobbered: &[PhysReg],
4896 ) -> Result<(), Unsupported> {
4897 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
4898 let form = x86_64::form(line.opcode).ok_or_else(refused)?;
4899 // What the instruction reaches and what is in each of them. The description answers the
4900 // first for every opcode but one, and the pieces the template was read into answer the
4901 // second. Bytes a program wrote out itself are the one, since nothing in a number is a
4902 // register anybody could read, so the constraint letters answer both. See
4903 // [`Self::lettered`].
4904 let lettered = (line.opcode == x86_64::LITERAL).then(|| self.lettered(list));
4905 let (described, pieces) = match &lettered {
4906 Some((described, pieces)) => (described.as_slice(), pieces.as_slice()),
4907 None => (form.operands(), line.operands.as_slice()),
4908 };
4909 let mut built = Vec::with_capacity(pieces.len() + clobbered.len());
4910 for (desc, piece) in described.iter().zip(pieces) {
4911 built.push(self.placed(inst, *desc, *piece, places, list)?);
4912 }
4913 // The clobbers go in among the definitions rather than behind the reads, because an operand
4914 // vector in the machine IR is every definition and then every use and what counts them
4915 // reads that order rather than each operand's role.
4916 let defs = built.iter().take_while(|operand| operand.role.is_def()).count();
4917 let mut added = 0usize;
4918 for ® in clobbered {
4919 if described.iter().any(|desc| desc.constraint == Constraint::Fixed(reg)) {
4920 continue;
4921 }
4922 built.insert(defs, mir::Operand::write(mir::Reg::physical(reg), self.gpr));
4923 added += 1;
4924 }
4925 // A constraint tying one operand to another names it by its place in this vector, and the
4926 // clobbers were put in the middle of the vector, so everything behind them moved. The
4927 // description is written against an instruction with no clobbers in it and cannot know
4928 // that, which makes this the one place the two numberings have to be reconciled.
4929 for operand in &mut built {
4930 if let Constraint::Reuse(at) = operand.constraint {
4931 if usize::from(at) >= defs {
4932 let moved = usize::from(at) + added;
4933 operand.constraint =
4934 Constraint::Reuse(u8::try_from(moved).map_err(|_| refused())?);
4935 }
4936 }
4937 }
4938 let at = match line.at {
4939 Some(at) => Some(self.addressed(inst, at, places, list)?),
4940 None => None,
4941 };
4942
4943 let block = self.at.expect("a block is being filled");
4944 let span = self.source.span(inst);
4945 let opcode = self.named(line.opcode);
4946 let mut build = self.out.build(block, opcode).at(span);
4947 for operand in built {
4948 build = build.operand(operand);
4949 }
4950 if let Some(value) = line.imm {
4951 build = build.imm(value);
4952 }
4953 if let Some(mem) = at {
4954 build = build.mem(mem);
4955 }
4956 build.finish();
4957 Ok(())
4958 }
4959
4960 /// The registers a run of bytes reaches, taken from the constraint letters rather than from the
4961 /// description of an opcode.
4962 ///
4963 /// Every other instruction of a template has a description saying which registers it reaches
4964 /// without naming them, and [`Self::assembly`] matches the letters against that. Bytes a program
4965 /// wrote out itself have no such description and could not have one: what the instruction is, is
4966 /// a number, and nothing in a number is a register anything could read. So the letters are the
4967 /// whole of what is known, and they are enough, because a program writing an instruction this
4968 /// way has to say where its operands go for exactly the reason a program writing `cpuid` does.
4969 ///
4970 /// Each register named by a letter gets one entry for the write and one for the read, the same
4971 /// two `cpuid` has, and only the half the statement asked for: a register no output names is not
4972 /// written here and one no input names is not read. The writes come first because that is the
4973 /// order an operand vector in the machine IR is counted in. A register named by nothing is left
4974 /// out rather than given a spare one, which is the difference from `cpuid` and is right for the
4975 /// same reason: `cpuid` writes four registers whatever the program said, and what these bytes
4976 /// touch is known only from what the program said.
4977 fn lettered(&self, list: &[AsmOperand<'_>]) -> (Vec<OperandDesc>, Vec<x86_64::Piece>) {
4978 let mut named: Vec<PhysReg> = Vec::new();
4979 for operand in list {
4980 if let Some(reg) = pinned(operand) {
4981 if !named.contains(®) {
4982 named.push(reg);
4983 }
4984 }
4985 }
4986 let mut described = Vec::with_capacity(named.len() * 2);
4987 let mut pieces = Vec::with_capacity(named.len() * 2);
4988 for role in [Role::Def, Role::Use] {
4989 for ® in &named {
4990 if bound(list, reg, role).is_none() {
4991 continue;
4992 }
4993 let desc = if role.is_def() {
4994 OperandDesc::write(self.gpr)
4995 } else {
4996 OperandDesc::read(self.gpr)
4997 };
4998 described.push(desc.with(Constraint::Fixed(reg)));
4999 pieces.push(x86_64::Piece::Implicit { reg });
5000 }
5001 }
5002 (described, pieces)
5003 }
5004
5005 /// One operand of one instruction of a template, in the register the statement put it in.
5006 fn placed(
5007 &mut self,
5008 inst: Inst,
5009 desc: OperandDesc,
5010 piece: x86_64::Piece,
5011 places: &[Place],
5012 list: &[AsmOperand<'_>],
5013 ) -> Result<mir::Operand, Unsupported> {
5014 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5015 // A register the instruction reaches without its text naming it belongs to whichever of the
5016 // statement's operands a constraint letter put there, and to nobody when no letter did.
5017 // There is no width to check in that case: the operand is the register the letter named and
5018 // the instruction does what it does to it, which is what a program writing `"=a"` asked for.
5019 let (index, spelled) = match piece {
5020 x86_64::Piece::Operand { index, width, stated } => (index, Some((width, stated))),
5021 x86_64::Piece::Implicit { reg } => match bound(list, reg, desc.role) {
5022 Some(index) => (index, None),
5023 None => return self.spare(inst, desc),
5024 },
5025 // A register the template named, which belongs to one of the statement's operands when
5026 // a constraint letter put that operand there and to nobody otherwise. Asked in that
5027 // order rather than placed straight away, because `"D" (p)` with `%rdi` in the text is
5028 // the program saying one thing twice, and answering it twice would hand the allocator
5029 // one register holding two values.
5030 x86_64::Piece::Reg { reg, .. } => match bound(list, reg, desc.role) {
5031 Some(index) => (index, None),
5032 None => return self.itself(inst, desc, reg),
5033 },
5034 };
5035 let operand = list.get(index).copied().ok_or_else(refused)?;
5036 // The two halves of an operand written `+`, which arrives in one register and leaves in
5037 // another with the allocator told to make them the same one. Everything else has one of
5038 // the two and asking for the other is the refusal below.
5039 let place = places.get(index).copied().ok_or_else(refused)?;
5040 let reg = match desc.role {
5041 Role::Use => place.read,
5042 Role::Def | Role::EarlyDef => place.write,
5043 }
5044 .ok_or_else(refused)?;
5045
5046 // Read where the opcode reads and written where it writes, which is what the first half of
5047 // this asks. An output has a result and an input has a value, an output written `+` has
5048 // both because it is read before it is written, and an output a matching constraint names
5049 // is read as the input that named it. See [`read_as`].
5050 // An output with neither is read as well, and what it holds there is undefined, which
5051 // [`Self::assembly`] says why and puts a zero in a register for.
5052 let placeable = match desc.role {
5053 Role::Use => read_as(list, index).is_some() || operand.result.is_some(),
5054 Role::Def | Role::EarlyDef => operand.result.is_some(),
5055 };
5056 let ty = match (operand.result, operand.value) {
5057 (Some(result), _) => self.source[result].ty,
5058 (None, Some(value)) => self.source[value].ty,
5059 (None, None) => return Err(refused()),
5060 };
5061 let bits = held_bits(ty);
5062 if !placeable || self.class_of(ty) != desc.class {
5063 return Err(refused());
5064 }
5065 if let Some((width, stated)) = spelled {
5066 // An operand the template wrote a width on may be written by an instruction that fills
5067 // more of the register than the object in it does, and the object is then the low part
5068 // of what was written. That is what gmp asks for when it counts the low zero bits of a
5069 // limb into an `unsigned` and spells the count `%q0`: one quadword instruction writes
5070 // the whole register and the `unsigned` is the bottom of it, which is every bit of an
5071 // answer that cannot exceed sixty four anyway.
5072 //
5073 // An operand read at a width the template wrote is the other way round: the object is
5074 // in the register and the instruction looks at the bottom of it. tcc tests the low bits
5075 // of a `size_t` count with `testb $2,%b4`, and every bit that test reads is one the
5076 // object put there.
5077 //
5078 // A write of less of a register than the object fills is right in one case, which is
5079 // an instruction that reads the register it writes and an operand that arrives with
5080 // the object in it. The top of the register is then the top of the object, and the
5081 // instruction leaves it alone. tcc swaps the bytes of an `unsigned` with `xchgb
5082 // %b0,%h0` and a rotate between two of them, and the swap only ever touches the low
5083 // half.
5084 //
5085 // The two that stay refused are a read of more of a register than its type fills,
5086 // which hands an instruction bits nothing ever put there, and a write of less of one
5087 // that nothing carried the object into, which leaves the top of the object holding
5088 // whatever the register held before. An operand the template left plain is refused
5089 // either way, because what gets spelled for that one is the register at the width of
5090 // its type and no other instruction is the one written down.
5091 let carried = matches!(desc.constraint, Constraint::Reuse(_) | Constraint::Fixed(_))
5092 && read_as(list, index).is_some();
5093 // The other case is the one the machine settles by itself: a write of the low four
5094 // bytes of a register clears the four above them, so a sixty four bit object written
5095 // that way holds the thirty two bit answer and nothing else. tcc loads a word through
5096 // `movl 4(%0),%k0` into a `long` and means exactly that.
5097 let cleared = desc.class == self.gpr && width == x86_64::Width::Long && bits == 64;
5098 let widened = stated && desc.role.is_def() && width.bits() > bits;
5099 let narrowed =
5100 stated && width.bits() < bits && (!desc.role.is_def() || carried || cleared);
5101 if bits != width.bits() && !widened && !narrowed {
5102 return Err(refused());
5103 }
5104 }
5105 // An operand the program pinned is in that register and nowhere else, whatever the opcode
5106 // would have allowed it. That is the whole of what a local register variable asks for, and
5107 // it is the same shape a division already has: the allocator is told the register, puts a
5108 // move in front or behind where it has to, and leaves it out where it does not.
5109 let constraint = match pinned(&operand) {
5110 Some(reg) => Constraint::Fixed(reg),
5111 None => desc.constraint,
5112 };
5113 Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint })
5114 }
5115
5116 /// A register the template named in its own text.
5117 ///
5118 /// Not one of the statement's operands and not something the allocator handed out. The program
5119 /// wrote `%rbx` in the middle of a template and meant that register, which is what code doing
5120 /// something the constraint letters cannot say is made of: micropython saves the callee-saved
5121 /// registers into a buffer by name because the whole point of the buffer is that those exact
5122 /// registers are in it, and there is no constraint letter for `%rsp`.
5123 ///
5124 /// So it is placed as itself, fixed to the register the template named. What that buys is the
5125 /// thing gcc does not do: the register becomes part of the instruction the allocator sees, so a
5126 /// write of one is a definition it knows about and will not leave anything of the program's
5127 /// across, and a read of one is a use it will not have put something else in first. gcc copies
5128 /// the text out and a register two things believe they own is a wrong program nothing reports.
5129 /// Here the allocator is told, and a program that also named the register in its clobber list
5130 /// says the same thing twice rather than something new.
5131 fn itself(
5132 &mut self,
5133 inst: Inst,
5134 desc: OperandDesc,
5135 reg: PhysReg,
5136 ) -> Result<mir::Operand, Unsupported> {
5137 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5138 if desc.class != self.gpr {
5139 return Err(refused);
5140 }
5141 Ok(mir::Operand {
5142 reg: mir::Reg::physical(reg),
5143 class: self.gpr,
5144 role: desc.role,
5145 constraint: Constraint::Fixed(reg),
5146 })
5147 }
5148
5149 /// A register an instruction of a template uses and the statement put nothing in.
5150 ///
5151 /// A write of one is the register being destroyed, which is what a clobber list is usually
5152 /// written to say and what an instruction with more answers than the program asked for does
5153 /// anyway: `cpuid` writes all four registers whether or not the statement wanted all four. A
5154 /// register of its own is the whole of what that needs, since a value nothing reads is one the
5155 /// allocator may put anywhere and is told about so that nothing else is put there.
5156 ///
5157 /// A read of one is a register the instruction looks at and the program never filled, which
5158 /// gcc leaves as whatever happened to be there. A zero is written instead, for the reason
5159 /// [`Self::undefined`] gives: the allocator has to be given a definition before a use, and a
5160 /// zero is the one answer that reads the same on every run.
5161 fn spare(&mut self, inst: Inst, desc: OperandDesc) -> Result<mir::Operand, Unsupported> {
5162 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5163 if desc.class != self.gpr {
5164 return Err(refused);
5165 }
5166 let reg = self.out.new_vreg(desc.class);
5167 if !desc.role.is_def() {
5168 let block = self.at.expect("a block is being filled");
5169 let span = self.source.span(inst);
5170 let put = self.named("mov_ri_64");
5171 self.out.build(block, put).at(span).def(reg, desc.class).imm(0).finish();
5172 }
5173 Ok(mir::Operand { reg, class: desc.class, role: desc.role, constraint: desc.constraint })
5174 }
5175
5176 /// The address one instruction of a template reads or writes.
5177 fn addressed(
5178 &mut self,
5179 inst: Inst,
5180 at: x86_64::At,
5181 places: &[Place],
5182 list: &[AsmOperand<'_>],
5183 ) -> Result<mir::Mem, Unsupported> {
5184 let refused = || Unsupported::Assembly { inst, refused: Written::Operand };
5185 let base = match at.base {
5186 None => None,
5187 Some(x86_64::Piece::Operand { index, .. }) => {
5188 // The register an address is counted from is read and never written, whatever the
5189 // instruction does to what it finds there.
5190 let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5191 Some(mir::Operand::read(reg, self.gpr))
5192 }
5193 // A register the template named, counted from as itself. See [`Self::itself`], and note
5194 // that this is the half of it every one of these templates needs: `movq %rax, 16(%rdi)`
5195 // names one register as the thing being stored and another as where to store it. An
5196 // operand a constraint letter put in that register is that operand, for the reason
5197 // [`Self::placed`] gives.
5198 Some(x86_64::Piece::Reg { reg, .. }) => match bound(list, reg, Role::Use) {
5199 Some(index) => {
5200 let reg = places.get(index).and_then(|place| place.read).ok_or_else(refused)?;
5201 Some(mir::Operand::read(reg, self.gpr))
5202 }
5203 None => Some(
5204 mir::Operand::read(mir::Reg::physical(reg), self.gpr)
5205 .with(Constraint::Fixed(reg)),
5206 ),
5207 },
5208 // An address counted from a register the instruction reaches without being told is
5209 // not something this machine has: every addressing mode is written out in the text it
5210 // is part of, so a base that got here another way is a base nothing wrote down.
5211 Some(x86_64::Piece::Implicit { .. }) => return Err(refused()),
5212 };
5213 // A distance the template wrote, or the one in an operand the template pointed at, which is
5214 // the same distance said by something that knows how big a thing is. It has to be a number
5215 // the compiler can read at translation time, since it goes in the instruction rather than
5216 // in a register, and an operand holding anything else is refused rather than put somewhere.
5217 let disp = match at.disp {
5218 x86_64::Disp::Number(disp) => disp,
5219 x86_64::Disp::Operand(index) => {
5220 let value =
5221 list.get(index).and_then(|operand| operand.value).ok_or_else(refused)?;
5222 let number = self.number(value).ok_or_else(refused)?;
5223 i32::try_from(number).map_err(|_| refused())?
5224 }
5225 };
5226 Ok(mir::Mem { base, scale: 1, disp, segment: at.segment, ..mir::Mem::default() })
5227 }
5228
5229 /// The number in that value, for one an `iconst` defined, read at the width of its own type.
5230 ///
5231 /// Signed, because the two things a template asks this for are a distance into an address and
5232 /// the number on an instruction, and both of those are signed wherever they land. A constant
5233 /// whose type is unsigned and whose top bit is set therefore reads as a negative number here,
5234 /// which is the same number and is the reading that fits in the thirty two bits an addressing
5235 /// mode has room for.
5236 fn number(&self, value: Value) -> Option<i128> {
5237 let Def::Result { inst, .. } = self.source[value].def else { return None };
5238 if self.source[inst].opcode != Opcode::IConst {
5239 return None;
5240 }
5241 let Extra::Imm(imm) = self.source[inst].extra else { return None };
5242 let bits = self.source[imm].bits();
5243 let width = self.source[value].ty.bits();
5244 if width == 0 || width > 128 {
5245 return None;
5246 }
5247 let spare = 128 - width;
5248 Some(((bits << spare) as i128) >> spare)
5249 }
5250
5251 /// A register holding a value the program has no claim on, written as a zero.
5252 ///
5253 /// Every other way of saying it costs the same instruction or needs a word the machine IR does
5254 /// not have, and a zero is the one that reads the same on every run.
5255 fn undefined(&mut self, inst: Inst, result: Value) -> Result<(), Unsupported> {
5256 let ty = self.source[result].ty;
5257 let refused = Unsupported::Assembly { inst, refused: Written::Operand };
5258 let bits = held_bits(ty);
5259 if self.class_of(ty) != self.gpr || !matches!(bits, 8 | 16 | 32 | 64) {
5260 return Err(refused);
5261 }
5262 let block = self.at.expect("a block is being filled");
5263 let span = self.source.span(inst);
5264 let reg = self.new_reg(result);
5265 let put = self.named(&format!("mov_ri_{bits}"));
5266 self.out.build(block, put).at(span).def(reg, self.gpr).imm(0).finish();
5267 Ok(())
5268 }
5269
5270 /// Whether a type is the width an address is, which is what makes a cast to or from one free.
5271 fn is_address_width(&self, ty: Type) -> bool {
5272 ty.is_ptr() || (ty.is_int() && ty.bits() == ADDRESS_BITS)
5273 }
5274
5275 /// Where a block goes, which in machine IR is on the block rather than on its terminator.
5276 ///
5277 /// That is why no rule ever names a block: a branch is selected for what it reads and the
5278 /// edges are copied across here, arguments and all. The arguments are read last, after every
5279 /// instruction of the block is written, because an argument that is a constant is
5280 /// materialized where it is first wanted and the end of the block is where an edge wants it.
5281 ///
5282 /// Which is not quite the end. A block that leaves two ways has the branch as its last
5283 /// instruction, and a block that leaves through a register has the indirect jump as its last,
5284 /// and anything appended after either is something it has already jumped past, so a constant
5285 /// materialized here would be a register the block below reads and nothing ever writes. The
5286 /// one that was there is put back on the end when that happened, which is the only reordering
5287 /// anything in this crate does and is why it is remembered before a single argument is read.
5288 fn edges(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5289 let Some(term) = self.source.terminator(block) else { return Ok(()) };
5290 let leaves =
5291 matches!(self.source[term].opcode, Opcode::BrIf | Opcode::IndirectBr | Opcode::Switch);
5292 let branch = if leaves { self.out.terminator(out) } else { None };
5293
5294 let calls: Vec<rucc_ir::BlockCall> = self.source.successors(term).collect();
5295 let mut succs = Vec::with_capacity(calls.len());
5296 for call in calls {
5297 let args: Vec<Value> = self.source[call.args].to_vec();
5298 let mut regs = Vec::with_capacity(args.len());
5299 for value in args {
5300 // The address of where the value is rather than the value, for the one type a
5301 // register holds none of. The block on the other side copies the bytes out of it
5302 // into a slot of its own, which is what makes a second edge into the same block
5303 // safe.
5304 let reg = if on_x87(self.source[value].ty) {
5305 self.x87_slot(value)
5306 } else {
5307 self.reg_of(value)?
5308 };
5309 regs.push(reg);
5310 }
5311 succs.push(mir::BlockCall::with(self.out_block(call.block), regs));
5312 }
5313 if let Some(branch) = branch {
5314 if self.out.terminator(out) != Some(branch) {
5315 self.out.remove_inst(branch);
5316 self.out.append_inst(out, branch);
5317 }
5318 }
5319 *self.out.succs_mut(out) = succs;
5320 Ok(())
5321 }
5322
5323 /// The machine IR block an IR block became.
5324 fn out_block(&self, block: Block) -> mir::Block {
5325 self.blocks[block.index()].expect("every block was created before any was filled")
5326 }
5327
5328 /// The parameters of the entry block, which are the function's arguments.
5329 ///
5330 /// They are not block parameters in the machine IR and they cannot be. A block parameter is
5331 /// given its value by a move on the edge into the block, and there is no edge into an entry
5332 /// block, so what arrives in a function is the convention's to say. [`crate::abi`] is what
5333 /// says it.
5334 ///
5335 /// The ones past the last register arrived in the caller's memory and are read out of it, and
5336 /// the loads that read them come back here so that the frame can finish them the way it
5337 /// finishes an `alloca`.
5338 fn arrive(&mut self, block: Block, out: mir::Block) -> Result<(), Unsupported> {
5339 let params = self.source[block].params.clone();
5340 // The type of each is the block's answer and what the ABI asks of it is the signature's,
5341 // and the two lists are the same list: a parameter the classification turned into a
5342 // pointer is a pointer in the block too. A block with more parameters than the signature
5343 // names is not one the front end writes, and each of those is taken as a plain value.
5344 let asked: Vec<Abi> = self.source.signature().params.iter().map(|it| it.abi).collect();
5345 let types: Vec<Param> = params
5346 .iter()
5347 .enumerate()
5348 .map(|(index, &value)| {
5349 let abi = asked.get(index).copied().unwrap_or_default();
5350 Param { ty: self.source[value].ty, abi }
5351 })
5352 .collect();
5353 // A save area for a function that takes arguments its signature does not name, which is a
5354 // block of this function's frame on one convention and the shadow space the caller already
5355 // reserved on the other. Which of the two it is is [`varargs::Area::of`]'s answer and
5356 // [`Self::save_area`] is where the difference is spent.
5357 //
5358 // Apple's AArch64 is neither. Every argument a signature does not name is in the caller's
5359 // memory, so there is nothing to save and the list starts at the first word past the named
5360 // ones.
5361 //
5362 // A function holding `__builtin_apply_args` asks for the same area whether it is variadic
5363 // or not, because what it saves is every argument register, and the area is where the
5364 // walk that binds them says where each one goes.
5365 let variadic = self.source.signature().variadic;
5366 let in_memory = self.conv.abi.variadic == Variadic::AlwaysMemory;
5367 let applies = self.saves_arguments();
5368 let area = (variadic && !in_memory || applies).then(|| varargs::Area::of(self.conv));
5369 let arrived =
5370 abi::entry(&mut self.out, out, &types, self.conv, self.selector.abi, self.names, area)
5371 .map_err(|(index, missing)| Unsupported::Argument { index, missing })?;
5372 for (¶m, reg) in params.iter().zip(&arrived.regs) {
5373 self.regs[param.index()] = Some(*reg);
5374 }
5375 if applies {
5376 self.save_arguments(out, &arrived);
5377 }
5378 if let (true, Some(area)) = (variadic && !in_memory, area) {
5379 self.save_area(out, &arrived, area);
5380 } else if variadic {
5381 let incoming = arrived.beyond.next_multiple_of(self.conv.word);
5382 self.varargs = Some(Varargs::Pointer { incoming });
5383 }
5384 self.stack.arguments.extend(arrived.stack);
5385 Ok(())
5386 }
5387
5388 /// The prologue of a variadic function, which is every argument register it was handed written
5389 /// into the frame.
5390 ///
5391 /// Every one the signature did not name, that is. Which of those hold anything is a thing only
5392 /// the caller knew and there is nothing here to ask, so all of them are written, and the ones a
5393 /// named parameter took are not, because `va_start` sets the two offsets past them and nothing
5394 /// ever reads their slots.
5395 ///
5396 /// What that costs is up to fourteen stores in the prologue of a function that may read none of
5397 /// them, and the convention's answer to that is the count of vector registers in `%al`, which
5398 /// lets a callee skip the eight vector stores when the call passed no floats. Skipping them is a
5399 /// branch in a prologue, and a prologue is written long after this by [`crate::finish`], which
5400 /// has no blocks to branch between. So they are all written every time, which is correct and is
5401 /// what `-O0` costs. Issue #323 is the branch.
5402 ///
5403 /// A vector register is written all sixteen bytes at a time, because a `_Float128` fills one and
5404 /// a `va_arg` of a quad reads the slot back whole. gcc writes the same sixteen with the same
5405 /// instruction, which is what [`crate::varargs`] says a list has to be built out of.
5406 ///
5407 /// The address is computed once into a register rather than written as a displacement off the
5408 /// stack pointer, because a displacement into a frame is not known until after allocation and
5409 /// one `lea` costs less than a fixup list for a dozen stores. It is the same `lea` an `alloca`
5410 /// gets and [`crate::finish`] fills it in the same way.
5411 ///
5412 /// A convention that homes its register arguments has none of that. Its area is the shadow
5413 /// space the caller reserved above the return address, so there is no object to make and no
5414 /// address to work out: each store reaches into the caller's argument area the way the load of
5415 /// a parameter the registers ran out before does, which is the same waiting list and the same
5416 /// fixup. There are at most four of them and none is a vector register, since a float the
5417 /// signature does not name arrived in a general purpose register too and that is the copy the
5418 /// walk reads.
5419 fn save_area(&mut self, out: mir::Block, arrived: &abi::Arrived, area: varargs::Area) {
5420 if self.conv.shared_positions {
5421 self.varargs = Some(Varargs::Pointer { incoming: arrived.beyond });
5422 let store = self.named("mov_mr_64");
5423 for &(reg, class, at) in &arrived.spare {
5424 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
5425 let made =
5426 self.out.build(out, store).uses(reg, class).mem(mir::Mem::at(sp)).finish();
5427 self.stack.arguments.push((made, at));
5428 }
5429 return;
5430 }
5431
5432 let save = self.stack.locals.len();
5433 self.stack.locals.push(Local { size: area.size, align: varargs::VECTOR_SLOT });
5434 let took = |count: usize, float: bool| {
5435 let count = u32::try_from(count).unwrap_or(0).min(area.holds(float));
5436 area.starts_at(float) + count * area.stride(float)
5437 };
5438 let integers = took(arrived.took.0, false);
5439 let floats = took(arrived.took.1, true);
5440 self.varargs = Some(if self.conv.list == VaList::Aapcs {
5441 // Minus what is left of each half, since the two offsets count up to its top.
5442 let left = |at: u32, float: bool| {
5443 i32::try_from(at).unwrap_or(0) - i32::try_from(area.ends_at(float)).unwrap_or(0)
5444 };
5445 Varargs::Aapcs {
5446 save,
5447 incoming: arrived.beyond,
5448 integers_end: area.ends_at(false),
5449 floats_end: area.ends_at(true),
5450 integers: left(integers, false),
5451 floats: left(floats, true),
5452 }
5453 } else {
5454 Varargs::Fields { save, incoming: arrived.beyond, integers, floats }
5455 });
5456
5457 // A vector register is saved all sixteen bytes wide, as a quad is, whatever it held.
5458 let base = self.frame_address(out, save);
5459 for &(reg, class, at) in &arrived.spare {
5460 let ty =
5461 if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
5462 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5463 let store = mir::Opcode::new(self.names.intern(head));
5464 let up = i32::try_from(at).expect("a register save area under two gigabytes");
5465 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
5466 self.out.build(out, store).uses(reg, class).mem(mem).finish();
5467 }
5468 }
5469
5470 /// Whether the function holds a `__builtin_apply_args`, on a convention this can save the
5471 /// arguments of.
5472 ///
5473 /// Only the one that keeps the two register files apart and saves them the way a SysV list
5474 /// does, since the block is that layout with one word in front of it. On any other the call is
5475 /// refused where it stands, which is [`Self::apply_args`] finding nothing saved.
5476 fn saves_arguments(&self) -> bool {
5477 if self.conv.list != VaList::SysV || self.conv.shared_positions {
5478 return false;
5479 }
5480 let source = self.source;
5481 source
5482 .blocks()
5483 .any(|block| source.insts(block).any(|inst| source[inst].opcode == Opcode::ApplyArgs))
5484 }
5485
5486 /// The prologue of a function holding `__builtin_apply_args`, which is every argument register
5487 /// it was handed and where the arguments in memory start, written into a block of its frame.
5488 ///
5489 /// The block is the one gcc lays out on this convention, so that a program reading it the way
5490 /// gcc's manual says reads the same bytes:
5491 ///
5492 /// ```text
5493 /// 0 where the arguments that came in memory are
5494 /// 8 nothing, so that what follows is sixteen byte aligned
5495 /// 16..64 the six general purpose argument registers, a word each
5496 /// 64..192 the eight vector argument registers, sixteen bytes each
5497 /// ```
5498 ///
5499 /// Which is the register save area of a variadic function with a word and a pad in front, so
5500 /// the offsets are that area's plus sixteen. What is different is that every register is
5501 /// written and not only the ones no parameter took: the one a parameter arrived in is written
5502 /// from the register the parameter was bound to, which holds it untouched because nothing has
5503 /// run yet, and the rest from the pseudos the walk made for them.
5504 fn save_arguments(&mut self, out: mir::Block, arrived: &abi::Arrived) {
5505 let applied = self.stack.locals.len();
5506 self.stack.locals.push(Local { size: APPLY_ARGS, align: varargs::VECTOR_SLOT });
5507 self.applied = Some(applied);
5508 let base = self.frame_address(out, applied);
5509 let overflow = self.overflow(out, 0, Span::DUMMY);
5510 let head = (self.selector.abi.store)(Type::int(64)).expect("a store of an address");
5511 let store = mir::Opcode::new(self.names.intern(head));
5512 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr));
5513 self.out.build(out, store).uses(overflow, self.gpr).mem(mem).finish();
5514
5515 let named = arrived.named.iter().map(|&(index, at)| {
5516 let reg = arrived.regs[index];
5517 let class = self.out.class_of(reg).unwrap_or(self.gpr);
5518 (reg, class, at)
5519 });
5520 let every: Vec<_> = named.chain(arrived.spare.iter().copied()).collect();
5521 for (reg, class, at) in every {
5522 let ty =
5523 if class == self.gpr { Type::int(64) } else { Type::float(rucc_ir::Float::F128) };
5524 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5525 let store = mir::Opcode::new(self.names.intern(head));
5526 let up = i32::try_from(at + APPLY_REGS).expect("a block of under two gigabytes");
5527 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(up);
5528 self.out.build(out, store).uses(reg, class).mem(mem).finish();
5529 }
5530 }
5531
5532 /// One `__builtin_apply_args`, which is the address of the block the prologue wrote.
5533 fn apply_args(&mut self, inst: Inst) -> Result<(), Unsupported> {
5534 let Some(applied) = self.applied else { return Err(self.unsupported(inst)) };
5535 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5536 let block = self.at.expect("a block is being filled");
5537 let reg = self.frame_address(block, applied);
5538 self.regs[result.index()] = Some(reg);
5539 Ok(())
5540 }
5541
5542 /// One `__builtin_apply`, which is a call whose arguments are every register in a block
5543 /// `__builtin_apply_args` answered and some bytes of the memory it says the arguments in
5544 /// memory were in.
5545 ///
5546 /// Built as a call of fourteen arguments, six words and eight vectors, which puts each in the
5547 /// register it came out of, and one object of the size the program gave, which is copied into
5548 /// the bottom of the outgoing area the way a structure passed by value is. The call is made as
5549 /// to a variadic function, so the count of vector registers is eight and a variadic callee
5550 /// saves all of them.
5551 ///
5552 /// What comes back is every register a value can come back in, which is two of each file, and
5553 /// they are written into a block of this function's frame whose address is the answer: the two
5554 /// words at 0 and 8 and the two vectors at 16 and 32. An eighty bit value comes back on the x87
5555 /// stack and is not in it, which is the one thing gcc's block holds that this one does not.
5556 fn apply(&mut self, inst: Inst) -> Result<(), Unsupported> {
5557 if self.conv.list != VaList::SysV || self.conv.shared_positions {
5558 return Err(self.unsupported(inst));
5559 }
5560 let values: Vec<Value> = self.source[self.source[inst].args].to_vec();
5561 let [function, saved, size] = values[..] else { return Err(self.unsupported(inst)) };
5562 let size = self.number(size).ok_or_else(|| self.unsupported(inst))?;
5563 let size = u32::try_from(size).map_err(|_| self.unsupported(inst))?;
5564 let result = self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5565 let function = self.reg_of(function)?;
5566 let saved = self.reg_of(saved)?;
5567 let block = self.at.expect("a block is being filled");
5568 let span = self.source.span(inst);
5569
5570 let word = Type::int(64);
5571 let vector = Type::float(rucc_ir::Float::F128);
5572 let area = varargs::Area::of(self.conv);
5573 let load = |ty: Type| (self.selector.abi.load)(ty).expect("a load of a whole register");
5574 let (load_word, load_vector) = (load(word), load(vector));
5575 let mut read = |ty: Type, head: &str, class: RegClass, at: u32| {
5576 let reg = self.out.new_vreg(class);
5577 let opcode = mir::Opcode::new(self.names.intern(head));
5578 let at = i32::try_from(at).expect("a block of under two gigabytes");
5579 let mem = mir::Mem::at(mir::Operand::read(saved, self.gpr)).plus(at);
5580 self.out.build(block, opcode).at(span).def(reg, class).mem(mem).finish();
5581 abi::Passing { ty, reg, abi: Abi::Plain }
5582 };
5583 let sse = self.conv.sse_class;
5584 let gpr = self.gpr;
5585 let mut args = Vec::with_capacity(15);
5586 for (float, ty, head, class) in
5587 [(false, word, load_word, gpr), (true, vector, load_vector, sse)]
5588 {
5589 for index in 0..area.holds(float) {
5590 let at = APPLY_REGS + area.starts_at(float) + index * area.stride(float);
5591 args.push(read(ty, head, class, at));
5592 }
5593 }
5594 if size > 0 {
5595 let memory = read(word, load_word, gpr, 0);
5596 let object =
5597 Abi::ByVal { size: u64::from(size), align: 8, drains: rucc_ir::Drains::Nothing };
5598 args.push(abi::Passing { abi: object, ..memory });
5599 }
5600 let returns = [word, word, vector, vector];
5601 let what = abi::Calling {
5602 callee: abi::Callee::Through(function),
5603 args: &args,
5604 returns: &returns,
5605 variadic: true,
5606 named: args.len(),
5607 at: span,
5608 };
5609 let made = abi::call(&mut self.out, block, &what, self.conv, self.selector.abi, self.names)
5610 .map_err(|refused| Unsupported::Call { inst, refused })?;
5611 let calls = &mut self.stack.calls;
5612 *calls = Some(calls.unwrap_or(0).max(made.outgoing));
5613
5614 let back = self.stack.locals.len();
5615 self.stack.locals.push(Local { size: APPLY_BACK, align: varargs::VECTOR_SLOT });
5616 let base = self.frame_address(block, back);
5617 for ((®, ty), at) in made.results.iter().zip(returns).zip([0, 8, 16, 32]) {
5618 let class = if ty == word { gpr } else { sse };
5619 let head = (self.selector.abi.store)(ty).expect("a store of a whole register");
5620 let store = mir::Opcode::new(self.names.intern(head));
5621 let mem = mir::Mem::at(mir::Operand::read(base, self.gpr)).plus(at);
5622 self.out.build(block, store).at(span).uses(reg, class).mem(mem).finish();
5623 }
5624 let answer = self.frame_address(block, back);
5625 self.regs[result.index()] = Some(answer);
5626 Ok(())
5627 }
5628
5629 /// The address of one of the function's stack objects, in a fresh register.
5630 ///
5631 /// Written with nothing in its displacement, because where an object is in a frame is not known
5632 /// until after allocation, and given to [`crate::finish`] to fill in the way an `alloca` is.
5633 fn frame_address(&mut self, out: mir::Block, local: usize) -> mir::Reg {
5634 self.frame_address_plus(out, local, 0)
5635 }
5636
5637 /// The address some way into a local, which the frame finishes the same way, adding where the
5638 /// local is to what is already there.
5639 fn frame_address_plus(&mut self, out: mir::Block, local: usize, plus: u32) -> mir::Reg {
5640 let reg = self.out.new_vreg(self.gpr);
5641 let lea = self.named(self.selector.frame.lea);
5642 let sp = mir::Operand::read(mir::Reg::physical(self.conv.stack_pointer), self.gpr);
5643 let plus = i32::try_from(plus).expect("an offset into a local under two gigabytes");
5644 let mem = mir::Mem::at(sp).plus(plus);
5645 let made = self.out.build(out, lea).def(reg, self.gpr).mem(mem).finish();
5646 self.stack.addresses.push((made, local));
5647 reg
5648 }
5649
5650 /// Whether an instruction is one no machine instruction is written for where it stands.
5651 ///
5652 /// Four of them, and none is a lowering decision, which is why none is a rule. A constant is
5653 /// written where a register for it is first wanted rather than where the IR put it, and every
5654 /// reader of one may have folded it into an immediate, in which case nowhere is the right
5655 /// place. A return of nothing has nothing to put anywhere: the epilogue gives the frame back
5656 /// and leaves, and it is appended to every block with no successors long after this has
5657 /// finished, so a return with a value is one instruction here and a return without one is
5658 /// none. Unless the value went back through memory, in which case there is something to put
5659 /// somewhere after all and the IR does not carry it: the address the caller handed over has
5660 /// to be in `rax` on the way out, and [`Lowering::returned`] is what writes that.
5661 ///
5662 /// An unconditional jump is the third, and there is even less of it: the edge is on the
5663 /// block, and whether the block it goes to is the next one and needs no jump at all is the
5664 /// block layout's answer rather than this one's.
5665 ///
5666 /// The fourth is a point control does not arrive at, in both of the forms the IR has for it:
5667 /// the `unreachable` terminator the front end puts at the end of a function whose body can run
5668 /// off the bottom, and the `unreachable_hint` a call to `__builtin_unreachable` becomes. What
5669 /// to write for a place nothing reaches is a question with no wrong answer, and nothing is the
5670 /// smallest one and the one gcc 16.2.0 gives at `-O0`. The terminator leaves the block with no
5671 /// successors, so the epilogue lands at the end of it the way it does on any other block that
5672 /// goes nowhere, and the function cannot fall out of its own last instruction into whatever
5673 /// the assembler puts next.
5674 fn writes_nothing(&self, inst: Inst) -> bool {
5675 let data = &self.source[inst];
5676 match data.opcode {
5677 Opcode::IConst | Opcode::Jump | Opcode::Unreachable | Opcode::UnreachableHint => true,
5678 Opcode::Return => self.source[data.args].is_empty() && self.sret().is_none(),
5679 _ => false,
5680 }
5681 }
5682
5683 /// What every instruction in one block matched, with a set of values nobody may take.
5684 ///
5685 /// Backwards, because an instruction that has been folded into a later one does not get to
5686 /// fold anything into itself: the rule that took it only reached one level down, so what is
5687 /// under it is not in the term the matcher saw and cannot be replaced.
5688 fn decide(&self, insts: &[Inst], refused: &HashSet<Value>) -> Decided {
5689 let mut found: Vec<Option<Match<Term>>> = (0..insts.len()).map(|_| None).collect();
5690 let mut plans: Vec<Option<Plan>> = vec![None; insts.len()];
5691 let mut folded: Vec<Inst> = Vec::new();
5692 for (index, &inst) in insts.iter().enumerate().rev() {
5693 if folded.contains(&inst) {
5694 continue;
5695 }
5696 if let Some((plan, matched)) = self.select(inst, refused) {
5697 folded.extend(self.folds(inst, plan));
5698 found[index] = Some(matched);
5699 plans[index] = Some(plan);
5700 }
5701 }
5702 Decided { found, plans, folded }
5703 }
5704
5705 /// A value some of its readers took and some of them did not, which is the one case folding
5706 /// buys nothing.
5707 ///
5708 /// Folding does not delete the instruction that computed a value for anybody else, so a
5709 /// reader that did not take it still needs it in a register and the instruction stays. The
5710 /// reader that did take it now does that work again. Either all of them take it, in which
5711 /// case nothing is left to read it and the instruction goes, or none of them do.
5712 ///
5713 /// The count is over the whole function rather than over the block, since a value read from
5714 /// another block is read from a register there whatever this block decides. An instruction
5715 /// built by name rather than matched, a call being the one that matters, has no plan and so
5716 /// takes nothing, which is the right answer for it as well.
5717 fn left_alive(&self, insts: &[Inst], plans: &[Option<Plan>]) -> Option<Value> {
5718 let mut taken = vec![0u32; self.uses.len()];
5719 for (&inst, plan) in insts.iter().zip(plans) {
5720 let Some(plan) = plan else { continue };
5721 let args = &self.source[self.source[inst].args];
5722 for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
5723 if plan[index] == Shown::Expand {
5724 taken[arg.index()] += 1;
5725 }
5726 }
5727 }
5728 for (&inst, plan) in insts.iter().zip(plans) {
5729 let Some(plan) = plan else { continue };
5730 let args = &self.source[self.source[inst].args];
5731 for (index, &arg) in args.iter().take(MAX_ARGS).enumerate() {
5732 if plan[index] == Shown::Expand && taken[arg.index()] < self.uses[arg.index()] {
5733 return Some(arg);
5734 }
5735 }
5736 }
5737 None
5738 }
5739
5740 /// The rule that fires on an instruction, and what it bound.
5741 ///
5742 /// The plans are tried in order and the first that matches wins, which is the maximal munch
5743 /// `spec/10-backend.md` asks for: a plan that offers more to the matcher is tried before one
5744 /// that offers less.
5745 fn select(&self, inst: Inst, refused: &HashSet<Value>) -> Option<(Plan, Match<Term>)> {
5746 for plan in self.plans(inst, refused) {
5747 let terms = Terms::new(self.source, inst, plan);
5748 if let Some(matched) = self.selector.table.find(&terms, Term::Root) {
5749 return Some((plan, matched));
5750 }
5751 }
5752 None
5753 }
5754
5755 /// Every way this instruction can be shown to the matcher, most offered first.
5756 fn plans(&self, inst: Inst, refused: &HashSet<Value>) -> Vec<Plan> {
5757 let args = &self.source[self.source[inst].args];
5758 let mut plans = vec![PLAIN];
5759 for (index, &arg) in args.iter().enumerate().take(MAX_ARGS) {
5760 let mut ways = Vec::new();
5761 if self.foldable(inst, arg, refused) {
5762 ways.push(Shown::Expand);
5763 }
5764 if Terms::new(self.source, inst, PLAIN).constant(arg).is_some() {
5765 ways.push(Shown::Const);
5766 }
5767 ways.push(Shown::Reg);
5768 plans = plans
5769 .into_iter()
5770 .flat_map(|plan| {
5771 ways.iter().map(move |&way| {
5772 let mut next = plan;
5773 next[index] = way;
5774 next
5775 })
5776 })
5777 .collect();
5778 }
5779 plans
5780 }
5781
5782 /// Whether an operand may be shown as the instruction that computed it.
5783 ///
5784 /// It has to be in the same block, because a rule that folds one instruction into another
5785 /// moves the work to where the second one is. It has to be something rather than a block
5786 /// parameter, and not a constant, which is shown as a constant instead. And it has to be a
5787 /// value [`Lowering::left_alive`] has not put back, which is how the one reader at a time
5788 /// question is asked here: this says yes to a value with any number of readers, and a value
5789 /// only some of them could take is refused after the fact and asked again.
5790 ///
5791 /// A value with several readers used to be refused outright, on the reasoning that folding
5792 /// does not delete the instruction for anybody else. That reasoning is about the set of
5793 /// readers and was being applied to one reader at a time, which is stricter than it needs to
5794 /// be: when every reader takes it there is nobody left to read it and the instruction goes.
5795 /// An address a store and a load share is the shape that matters, since a memory operand has
5796 /// room for the whole of it and both readers have a memory operand.
5797 fn foldable(&self, into: Inst, value: Value, refused: &HashSet<Value>) -> bool {
5798 let Def::Result { inst, .. } = self.source[value].def else { return false };
5799 if self.source[inst].opcode == Opcode::IConst || refused.contains(&value) {
5800 return false;
5801 }
5802 self.source.block_of(inst).is_some()
5803 && self.source.block_of(inst) == self.source.block_of(into)
5804 }
5805
5806 /// The instructions a match folded into the one it matched.
5807 ///
5808 /// The plan is what says this, not the bindings: a binding is a register or a number either
5809 /// way, and an operand shown as the instruction that computed it is one no rule could have
5810 /// matched without taking that instruction, because the plan offered the matcher nothing
5811 /// else to call it.
5812 fn folds(&self, inst: Inst, plan: Plan) -> Vec<Inst> {
5813 let args = &self.source[self.source[inst].args];
5814 args.iter()
5815 .take(MAX_ARGS)
5816 .enumerate()
5817 .filter(|&(index, _)| plan[index] == Shown::Expand)
5818 .filter_map(|(_, &arg)| match self.source[arg].def {
5819 Def::Result { inst, .. } => Some(inst),
5820 Def::Param { .. } => None,
5821 })
5822 .collect()
5823 }
5824
5825 /// What the IR instruction said about itself that the machine instruction has to keep saying.
5826 ///
5827 /// One flag today. `volatile` says the access happens exactly once and is never moved or
5828 /// merged, and nothing below here can work that out again: a `volatile` load and an ordinary
5829 /// one are the same instruction over the same address, so a pass that puts two accesses
5830 /// together would put these together too. Carried rather than checked here, because the pass
5831 /// that has to refuse is a long way down and this is the last place the answer is known.
5832 ///
5833 /// The instructions this compiler writes for itself get nothing, which is the right answer
5834 /// for all of them: a prologue, a spill and the moves around a call were asked for by the
5835 /// machine rather than by the program.
5836 ///
5837 /// Every access the flag is legal on carries it: the loads and the stores a rule matched,
5838 /// the two ends of a `long double` copy that are the program's own memory, and the compare
5839 /// and exchange and the read modify write. An `asm` statement does not, and it is the one
5840 /// exception on purpose. What the flag says there is that the statement stays even when
5841 /// nothing reads what it wrote, which is a different sentence about a different thing, and
5842 /// every `asm` is already fixed where it stands whether the word was written or not.
5843 fn carried(&self, inst: Inst) -> mir::Flags {
5844 if self.source[inst].flags.contains(Flags::VOLATILE) {
5845 mir::Flags::VOLATILE
5846 } else {
5847 mir::Flags::NONE
5848 }
5849 }
5850
5851 /// Build the machine instructions a match calls for.
5852 fn emit(&mut self, inst: Inst, matched: &Match<Term>) -> Result<(), Unsupported> {
5853 let rule: &Rule = self.selector.table.rule(matched);
5854 self.build(inst, rule.replacement, 0, &matched.bindings, true).map(|_| ())
5855 }
5856
5857 /// Build the machine term that starts at `at`, and give back the position after it and the
5858 /// register it wrote, if it wrote one.
5859 ///
5860 /// The outermost term computes what the IR instruction does, so what it writes is the
5861 /// register of the instruction's result. A term inside another is a step on the way and
5862 /// writes a register of its own, which the term around it then reads. Its operands are read
5863 /// before it is built and it is built before the term around it, so the instructions come
5864 /// out in the order the values are needed.
5865 fn build(
5866 &mut self,
5867 inst: Inst,
5868 pieces: &'static [Piece],
5869 at: usize,
5870 bindings: &[Term],
5871 outermost: bool,
5872 ) -> Result<(usize, Option<mir::Reg>), Unsupported> {
5873 let Some(Piece::App { head, arity }) = pieces.get(at) else {
5874 return Err(self.unsupported(inst));
5875 };
5876 let opcode =
5877 head.strip_prefix(self.selector.prefix()).ok_or_else(|| self.unsupported(inst))?;
5878 let descs = self.selector.operands(opcode).ok_or_else(|| self.unsupported(inst))?;
5879
5880 let mut read = Read::default();
5881 let mut at = at + 1;
5882 for _ in 0..*arity {
5883 at = self.read(inst, pieces, at, bindings, &mut read)?;
5884 }
5885
5886 let writes = descs.iter().take_while(|desc| desc.role.is_def()).count();
5887 if descs.len() - writes != read.regs.len() {
5888 return Err(self.unsupported(inst));
5889 }
5890
5891 // The first thing the instruction writes is what it computes, and any others are
5892 // registers the machine destroys on the way, which are fresh because nothing else is in
5893 // them and nothing reads them. An instruction that writes nothing at all is one whose
5894 // whole purpose is its effect, which is what a store is, and there is no result to put
5895 // anywhere.
5896 let mut regs = Vec::new();
5897 if writes > 0 {
5898 // A term inside another computes a step rather than the result, into a register only
5899 // the term around it reads.
5900 let first = match outermost {
5901 true => {
5902 let result =
5903 self.source[inst].first_result.ok_or_else(|| self.unsupported(inst))?;
5904 self.new_reg(result)
5905 }
5906 false => self.out.new_vreg(descs[0].class),
5907 };
5908 regs.push(first);
5909 // The rest are the registers the machine destroys on the way, and the class each is in
5910 // is the one the instruction's description gives it rather than a guess, so that an
5911 // instruction that wrecks a register in the other file says so.
5912 regs.extend(descs[1..writes].iter().map(|desc| self.out.new_vreg(desc.class)));
5913 } else if !outermost || self.source[inst].first_result.is_some() {
5914 // A rule that throws away a value the IR gave a name to would leave every reader of
5915 // that name with nothing to read, so it is a rule this and the target disagree about.
5916 // So is a term inside another that writes nothing for the one around it to read.
5917 return Err(self.unsupported(inst));
5918 }
5919 let written = regs.first().copied();
5920 regs.extend(read.regs.iter().copied());
5921
5922 let block = self.at.expect("a block is being filled");
5923 let opcode = mir::Opcode::new(self.names.intern(head));
5924 let (span, flags) = (self.source.span(inst), self.carried(inst));
5925 let mut build = self.out.build(block, opcode).at(span).flags(flags);
5926 for (desc, reg) in descs.iter().zip(regs) {
5927 let operand = mir::Operand {
5928 reg,
5929 class: desc.class,
5930 role: desc.role,
5931 constraint: desc.constraint,
5932 };
5933 build = build.operand(operand);
5934 }
5935 if let Some(mem) = read.mem {
5936 build = build.mem(mem);
5937 }
5938 if let Some(imm) = read.imm {
5939 build = build.imm(imm);
5940 }
5941 build.finish();
5942 Ok((at, written))
5943 }
5944
5945 /// Read one argument of a replacement, which is a register, a number, an address or another
5946 /// machine term.
5947 ///
5948 /// Gives back the position after it, because a replacement is flat and an address or a term
5949 /// takes arguments of its own. A machine term is built on the spot, and what is read is the
5950 /// register it wrote.
5951 fn read(
5952 &mut self,
5953 inst: Inst,
5954 pieces: &'static [Piece],
5955 at: usize,
5956 bindings: &[Term],
5957 out: &mut Read,
5958 ) -> Result<usize, Unsupported> {
5959 match pieces.get(at) {
5960 Some(Piece::Int(value)) => {
5961 out.imm = i64::try_from(*value).ok();
5962 Ok(at + 1)
5963 }
5964 // A number the rule worked out of the ones it matched rather than one it wrote down,
5965 // which is an immediate once it has been worked out and is read here as one. It gives
5966 // nothing back when a binding it reads is a register, and a replacement that cannot be
5967 // built is a rule this file and the matcher disagree about, which is what `unsupported`
5968 // is for.
5969 Some(Piece::Computed { work, .. }) => {
5970 let matched: Vec<Option<i128>> = bindings
5971 .iter()
5972 .map(|term| match *term {
5973 Term::Num(value) => Some(value),
5974 _ => None,
5975 })
5976 .collect();
5977 let number = work(&matched).ok_or_else(|| self.unsupported(inst))?;
5978 out.imm = i64::try_from(number).ok();
5979 Ok(at + 1)
5980 }
5981 Some(Piece::Var { index, .. }) => {
5982 match bindings.get(*index) {
5983 Some(&Term::Reg(value)) => {
5984 let reg = self.reg_of(value)?;
5985 out.regs.push(reg);
5986 }
5987 Some(&Term::Num(value)) => out.imm = i64::try_from(value).ok(),
5988 // A pattern binds a register or a number and nothing else, so this is a
5989 // rule the matcher and this file disagree about.
5990 _ => return Err(self.unsupported(inst)),
5991 }
5992 Ok(at + 1)
5993 }
5994 Some(Piece::App { head, .. }) if (self.selector.address)(head).is_none() => {
5995 let (next, reg) = self.build(inst, pieces, at, bindings, false)?;
5996 out.regs.push(reg.ok_or_else(|| self.unsupported(inst))?);
5997 Ok(next)
5998 }
5999 Some(Piece::App { head, arity }) => {
6000 let kind = (self.selector.address)(head).ok_or_else(|| self.unsupported(inst))?;
6001 let mut inner = Read::default();
6002 let mut next = at + 1;
6003 for _ in 0..*arity {
6004 next = self.read(inst, pieces, next, bindings, &mut inner)?;
6005 }
6006 let mem = address(kind, &inner, self.gpr).ok_or_else(|| self.unsupported(inst))?;
6007 out.mem = Some(mem);
6008 Ok(next)
6009 }
6010 None => Err(self.unsupported(inst)),
6011 }
6012 }
6013
6014 /// The register a value is in, materializing it if it is a constant that has not been put in
6015 /// one yet.
6016 ///
6017 /// A constant is written where it is wanted rather than where the IR defined it, and where it
6018 /// is wanted is a block that need not be the one the IR defined it in. So the register holding
6019 /// one is only good inside the block it was written into, and a second block that wants the
6020 /// same constant gets its own. Anything else is a register read where nothing wrote it: the
6021 /// IR guarantees a definition dominates its uses, and this moved the definition.
6022 ///
6023 /// Writing the number again is also the right answer and not merely the safe one. It is one
6024 /// instruction that reads nothing, which is cheaper than holding a register live across a
6025 /// branch for it, and it is what a rematerializing allocator would do with the value anyway.
6026 fn reg_of(&mut self, value: Value) -> Result<mir::Reg, Unsupported> {
6027 let constant = match self.source[value].def {
6028 Def::Result { inst, .. } => {
6029 (self.source[inst].opcode == Opcode::IConst).then_some(inst)
6030 }
6031 Def::Param { .. } => None,
6032 };
6033 let here = self.at.expect("a block is being filled");
6034 if let Some(reg) = self.regs[value.index()] {
6035 if constant.is_none() || self.written[value.index()] == Some(here) {
6036 return Ok(reg);
6037 }
6038 }
6039 if let Some(inst) = constant {
6040 // Cleared so that the register the constant is written into is a new one rather than
6041 // the one the block above wrote, which is still being read up there.
6042 self.regs[value.index()] = None;
6043 // Nothing is refused here. A constant is written on its own, out of the loop over the
6044 // block, and the operands of the rule that writes one are the number and nothing else.
6045 let matched = self
6046 .select(inst, &HashSet::new())
6047 .map(|(_, matched)| matched)
6048 .ok_or_else(|| self.unsupported(inst))?;
6049 self.emit(inst, &matched)?;
6050 // The same mark the loop over the instructions makes, and it has to be made here as
6051 // well because this is the only place a constant is ever selected: the loop skips one
6052 // where the IR wrote it, so a rule that lowers a constant fires from nowhere else and
6053 // would be reported as a rule nothing reaches.
6054 self.fired.mark(matched.rule);
6055 self.written[value.index()] = Some(here);
6056 return Ok(self.regs[value.index()].expect("a constant is written into a register"));
6057 }
6058 Ok(self.new_reg(value))
6059 }
6060
6061 /// Which register file a value of that type lives in.
6062 ///
6063 /// The vector one for the two float widths the machine has scalar instructions for and for the
6064 /// one it only moves, and the general purpose one for everything else. An eighty bit `long
6065 /// double` is in neither, and it is here rather than in the vector class on purpose: it would
6066 /// be put in a register that cannot hold it, and there is no rule that names one, so the
6067 /// instruction computing it is reported. The wrong class would make that a wrong program
6068 /// instead of a refused one.
6069 ///
6070 /// A hundred and twenty eight bit float is in the vector class and fits it exactly, which is
6071 /// the difference. Nothing computes in it, so every arithmetic on one is still reported, and
6072 /// what the class buys is the moves: a register that holds the whole value is a register a
6073 /// spill, a reload and a copy are each one instruction for.
6074 fn class_of(&self, ty: Type) -> RegClass {
6075 if crate::term::in_vector_file(ty) { self.conv.sse_class } else { self.gpr }
6076 }
6077
6078 /// A fresh register for a value, which is what the instruction computing it writes.
6079 ///
6080 /// Any declaration the value is a value of comes with it. Here rather than once at the end over
6081 /// the whole map, because a constant is written again in every block that wants one and the map
6082 /// only remembers the last of those registers, and a local held in a constant is a local that
6083 /// would otherwise be findable in one block of the function and nowhere else.
6084 fn new_reg(&mut self, value: Value) -> mir::Reg {
6085 if let Some(reg) = self.regs[value.index()] {
6086 return reg;
6087 }
6088 let reg = self.out.new_vreg(self.class_of(self.source[value].ty));
6089 self.regs[value.index()] = Some(reg);
6090 let source = self.source;
6091 for decl in source.value_decls(value) {
6092 self.out.named.push((decl, reg));
6093 }
6094 reg
6095 }
6096
6097 fn unsupported(&self, inst: Inst) -> Unsupported {
6098 let data = &self.source[inst];
6099 Unsupported::Inst {
6100 inst,
6101 term: Terms::new(self.source, inst, PLAIN).name(inst),
6102 opcode: data.opcode,
6103 ty: data.first_result.map(|result| self.source[result].ty),
6104 }
6105 }
6106}
6107
6108/// What the arguments of one replacement came to.
6109#[derive(Debug, Default)]
6110struct Read {
6111 regs: Vec<mir::Reg>,
6112 imm: Option<i64>,
6113 mem: Option<mir::Mem>,
6114}
6115
6116/// The addressing mode an address constructor's arguments make.
6117///
6118/// One arm per constructor rather than a question asked of the kind, because what the arguments
6119/// mean is the whole of what tells the four apart: the same register is a base in one and an
6120/// index in another, and the same constant is a scale in one and a displacement in another.
6121fn address(kind: Address, read: &Read, gpr: RegClass) -> Option<mir::Mem> {
6122 let mut regs = read.regs.iter().copied().map(|reg| mir::Operand::read(reg, gpr));
6123 match kind {
6124 Address::BaseIndexScale => {
6125 let base = regs.next()?;
6126 let index = regs.next()?;
6127 Some(mir::Mem::at(base).indexed(index, u8::try_from(read.imm?).ok()?))
6128 }
6129 Address::IndexScale => Some(mir::Mem {
6130 base: None,
6131 index: Some(regs.next()?),
6132 scale: u8::try_from(read.imm?).ok()?,
6133 disp: 0,
6134 symbol: None,
6135 block: None,
6136 table: None,
6137 reach: mir::Reach::Itself,
6138 segment: None,
6139 }),
6140 Address::Base => Some(mir::Mem::at(regs.next()?)),
6141 // The rule that writes this has a guard saying the constant fits, so a displacement that
6142 // does not is a rule and a target that disagree rather than a program this cannot compile.
6143 Address::BaseOffset => {
6144 Some(mir::Mem { disp: i32::try_from(read.imm?).ok()?, ..mir::Mem::at(regs.next()?) })
6145 }
6146 }
6147}
6148
6149#[cfg(test)]
6150mod tests {
6151 use rucc_ir::{
6152 AsmInfo, Builder, CallInfo, Flags, InstData, MemInfo, MemOrder, Restrict, Signature, Type,
6153 };
6154 use rucc_regalloc::assign::Env;
6155 use rucc_target::x86_64::{FRAME, REGS, SYSV};
6156
6157 use super::*;
6158 use crate::finish::{Convention, finish};
6159 use crate::frame::{Frame, Incoming, Layout};
6160 use crate::select::x86_64::SELECTOR;
6161
6162 /// A function of as many 64 bit parameters as the test wants, and the block they are in.
6163 fn blank(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6164 let mut names = Interner::new();
6165 let mut func = Func::new(names.intern("f"), Signature::new());
6166 let block = func.create_block();
6167 let values = params.iter().map(|&ty| func.append_param(block, ty)).collect();
6168 (names, func, block, values)
6169 }
6170
6171 /// An ordinary access: not atomic, and aligned enough that nothing here has an opinion.
6172 /// Neither field reaches selection, which is the point of saying it once here.
6173 fn plain() -> MemInfo {
6174 MemInfo {
6175 size: 0,
6176 align: 1,
6177 order: MemOrder::NotAtomic,
6178 tbaa: None,
6179 owns: 0,
6180 restrict: Restrict::NONE,
6181 }
6182 }
6183
6184 /// What the allocator is given: every integer register the convention offers except two, held
6185 /// back so that a move on an edge has somewhere to break a cycle and a spilled value has
6186 /// somewhere to be read into. Which two does not matter, and holding back the last two the
6187 /// convention would reach for leaves every expectation below unchanged.
6188 fn env() -> Env {
6189 const SCRATCH: [PhysReg; 2] = [x86_64::R10, x86_64::R11];
6190 let order: Vec<PhysReg> =
6191 SYSV.int_order.iter().copied().filter(|reg| !SCRATCH.contains(reg)).collect();
6192 Env::new().with(x86_64::GPR, &order, &SCRATCH)
6193 }
6194
6195 /// The machine IR text a function lowers to.
6196 fn lower(names: &mut Interner, source: &Func) -> String {
6197 let out = func(source, names, &SELECTOR, &SYSV, &Elsewhere::default())
6198 .expect("every instruction has a rule");
6199 mir::print_func(&out.func, names, ®S)
6200 }
6201
6202 /// The same function lowered for AArch64, which is the first thing this file writes for a
6203 /// machine other than x86-64. Nothing past selection runs here, so what is checked is that the
6204 /// arguments, the rule and the return all come out named for the machine that was asked for.
6205 #[test]
6206 fn an_addition_lowers_for_aarch64_with_its_own_names() {
6207 let i32 = Type::int(32);
6208 let (mut names, mut func, block, args) = blank(&[i32, i32]);
6209 let mut build = Builder::new(&mut func, block);
6210 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
6211 build.ret(&[sum]);
6212
6213 let conv = &aarch64::AAPCS64;
6214 let selector = &crate::select::aarch64::SELECTOR;
6215 let out = super::func(&func, &mut names, selector, conv, &Elsewhere::default())
6216 .expect("an addition and a return have AArch64 rules");
6217 let text = mir::print_func(&out.func, &names, &aarch64::REGS);
6218 assert!(!text.contains("x64."), "{text}");
6219 assert!(text.contains("= a64.arg_val_32"), "{text}");
6220 assert!(text.contains("= a64.add_rr_32 %0, %1"), "{text}");
6221 assert!(text.contains("a64.ret_val_32 %2"), "{text}");
6222 }
6223
6224 /// Lowers one function for AArch64 and prints it, or says why it could not.
6225 fn lower_a64(names: &mut Interner, func: &Func) -> Result<String, String> {
6226 let conv = &aarch64::AAPCS64;
6227 let selector = &crate::select::aarch64::SELECTOR;
6228 let out = super::func(func, names, selector, conv, &Elsewhere::default())
6229 .map_err(|why| why.to_string())?;
6230 Ok(mir::print_func(&out.func, names, &aarch64::REGS))
6231 }
6232
6233 /// Nothing reads AArch64 assembly back into instructions, so every template there is kept as
6234 /// its text. The operands are the instruction's own, with the output first and the inputs
6235 /// last, a hole in the text asks for the `w` or the `x` name of one, and a vector register the
6236 /// clobber list names is written by it as well as every register a call may leave anything in.
6237 #[test]
6238 fn a_template_on_aarch64_is_kept_as_text_with_its_operands_in_registers() {
6239 let (i32, i64) = (Type::int(32), Type::int(64));
6240 let (mut names, mut source, block, args) = blank(&[i32, i64]);
6241 let out = clobbering(
6242 &mut source,
6243 block,
6244 &mut names,
6245 "add %w0, %w1, #1\n\tstr %2, [sp]",
6246 "=r,r,r",
6247 "d8",
6248 &[args[0], args[1]],
6249 &[i32],
6250 );
6251 let produced = source[out].results().next().expect("one result");
6252 Builder::new(&mut source, block).ret(&[produced]);
6253
6254 // Forty one registers between the output and the inputs: `x0` to `x15`, the sixteen vector
6255 // registers a call does not keep, and `v8`, which is the one the program named.
6256 let text = lower_a64(&mut names, &source).expect("kept as text");
6257 assert!(text.contains("%2:gpr, early $x0, early $x1,"), "{text}");
6258 assert!(text.contains(
6259 "early $v31, early $v8 = a64.template %0, %1, \
6260 @add \u{1}r0w\u{2}, \u{1}r42w\u{2}, #1\n\tstr \u{1}r43x\u{2}, [sp]\n"
6261 ));
6262 }
6263
6264 /// A letter that means one thing on x86 and another on AArch64 is refused there rather than
6265 /// read as x86. `a` to `d` and `S` name one register each on x86 and nothing on AArch64.
6266 #[test]
6267 fn a_constraint_letter_the_two_machines_disagree_about_is_refused_on_aarch64() {
6268 let i64 = Type::int(64);
6269 for constraints in ["=a,r", "=r,S", "=r,c"] {
6270 let (mut names, mut source, block, args) = blank(&[i64]);
6271 let out = clobbering(
6272 &mut source,
6273 block,
6274 &mut names,
6275 "mov %0, %1",
6276 constraints,
6277 "",
6278 &[args[0]],
6279 &[i64],
6280 );
6281 let produced = source[out].results().next().expect("one result");
6282 Builder::new(&mut source, block).ret(&[produced]);
6283 let refused = lower_a64(&mut names, &source).expect_err(constraints);
6284 assert!(refused.contains("has an operand this cannot place"), "{refused}");
6285 }
6286 }
6287
6288 /// `Q` on AArch64 is memory addressed by one register, which is `[x3]` and is how an operand in
6289 /// memory is spelled there already.
6290 #[test]
6291 fn a_q_operand_on_aarch64_is_its_address_in_brackets() {
6292 let (i64, ptr) = (Type::int(64), Type::PTR);
6293 let (mut names, mut source, block, args) = blank(&[ptr]);
6294 let out =
6295 clobbering(&mut source, block, &mut names, "ldr %x0, %1", "=r,Q", "", &args, &[i64]);
6296 let produced = source[out].results().next().expect("one result");
6297 Builder::new(&mut source, block).ret(&[produced]);
6298 let text = lower_a64(&mut names, &source).expect("kept as text");
6299 assert!(text.contains("@ldr \u{1}r0x\u{2}, [\u{1}r"), "{text}");
6300 }
6301
6302 /// `w` on AArch64 is a vector register, named `v` with no modifier the way gcc names it and by
6303 /// its scalar view with one. An integer asked for in one is refused, since it would need a move
6304 /// into that file first.
6305 #[test]
6306 fn a_vector_operand_on_aarch64_is_in_the_vector_file() {
6307 let f64 = Type::float(rucc_ir::Float::F64);
6308 let (mut names, mut source, block, args) = blank(&[f64, f64]);
6309 let out = clobbering(
6310 &mut source,
6311 block,
6312 &mut names,
6313 "fadd %d0, %d1, %d2\n\tmov %0.16b, %0.16b",
6314 "=w,w,w",
6315 "",
6316 &[args[0], args[1]],
6317 &[f64],
6318 );
6319 let produced = source[out].results().next().expect("one result");
6320 Builder::new(&mut source, block).ret(&[produced]);
6321 let text = lower_a64(&mut names, &source).expect("kept as text");
6322 assert!(text.contains("%2:fpr, early $x0,"), "{text}");
6323 assert!(text.contains("@fadd \u{1}r0d\u{2}, \u{1}r"), "{text}");
6324 assert!(text.contains("\n\tmov \u{1}r0v\u{2}.16b, \u{1}r0v\u{2}.16b\n"), "{text}");
6325
6326 let i64 = Type::int(64);
6327 let (mut names, mut source, block, args) = blank(&[i64]);
6328 let out =
6329 clobbering(&mut source, block, &mut names, "fmov %d0, %d1", "=w,w", "", &args, &[i64]);
6330 let produced = source[out].results().next().expect("one result");
6331 Builder::new(&mut source, block).ret(&[produced]);
6332 assert!(lower_a64(&mut names, &source).is_err());
6333 }
6334
6335 #[test]
6336 fn an_addition_of_two_registers_is_one_instruction() {
6337 let i32 = Type::int(32);
6338 let (mut names, mut func, block, args) = blank(&[i32, i32]);
6339 let mut build = Builder::new(&mut func, block);
6340 build.binary(Opcode::Add, args[0], args[1], Flags::default());
6341
6342 assert_eq!(
6343 lower(&mut names, &func),
6344 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
6345 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr(reuse 1) = x64.add_rr_32 %0, %1\n}\n"
6346 );
6347 }
6348
6349 #[test]
6350 fn a_constant_operand_becomes_an_immediate() {
6351 let i32 = Type::int(32);
6352 let (mut names, mut func, block, args) = blank(&[i32]);
6353 let mut build = Builder::new(&mut func, block);
6354 let seven = build.iconst(i32, 7);
6355 build.binary(Opcode::Add, args[0], seven, Flags::default());
6356
6357 // The constant is in the instruction and nothing was written to hold it, which is what
6358 // materializing one where a register for it is wanted buys.
6359 assert_eq!(
6360 lower(&mut names, &func),
6361 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
6362 %1:gpr(reuse 1) = x64.add_ri_32 %0, 7\n}\n"
6363 );
6364 }
6365
6366 #[test]
6367 fn a_constant_too_wide_for_an_immediate_goes_into_a_register() {
6368 let i64 = Type::int(64);
6369 let (mut names, mut func, block, args) = blank(&[i64]);
6370 let mut build = Builder::new(&mut func, block);
6371 let big = build.iconst(i64, i128::from(i32::MAX) + 1);
6372 build.binary(Opcode::Add, args[0], big, Flags::default());
6373
6374 // Nobody wrote this fallback down. The rule that takes an immediate has a guard that
6375 // turns a number this wide down, so it does not fire, and the next way of showing the
6376 // operand puts it in a register.
6377 assert_eq!(
6378 lower(&mut names, &func),
6379 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6380 %1:gpr = x64.mov_ri_64 2147483648\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n}\n"
6381 );
6382 }
6383
6384 #[test]
6385 fn an_index_calculation_folds_into_an_address() {
6386 let i64 = Type::int(64);
6387 let (mut names, mut func, block, args) = blank(&[i64, i64]);
6388 let mut build = Builder::new(&mut func, block);
6389 let four = build.iconst(i64, 4);
6390 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6391 build.binary(Opcode::Add, args[0], scaled, Flags::default());
6392
6393 // Three IR instructions and one machine instruction. The multiply is gone because the
6394 // rule that matched reached down and took it.
6395 assert_eq!(
6396 lower(&mut names, &func),
6397 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6398 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.lea_64 [%0 + %1*4]\n}\n"
6399 );
6400 }
6401
6402 #[test]
6403 fn an_instruction_every_reader_can_take_is_folded_into_all_of_them() {
6404 let i64 = Type::int(64);
6405 let (mut names, mut func, block, args) = blank(&[i64, i64]);
6406 let mut build = Builder::new(&mut func, block);
6407 let four = build.iconst(i64, 4);
6408 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6409 let first = build.binary(Opcode::Add, args[0], scaled, Flags::default());
6410 build.binary(Opcode::Add, first, scaled, Flags::default());
6411
6412 // Both readers have room for a scaled index, so both of them take it and nothing is left
6413 // to read the multiply. Three IR instructions become two machine ones, where refusing to
6414 // fold into either reader would have left three.
6415 assert_eq!(
6416 lower(&mut names, &func),
6417 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6418 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.lea_64 [%0 + %1*4]\n \
6419 %3:gpr = x64.lea_64 [%2 + %1*4]\n}\n"
6420 );
6421 }
6422
6423 #[test]
6424 fn an_instruction_one_of_its_readers_cannot_take_is_folded_into_none_of_them() {
6425 let i64 = Type::int(64);
6426 let (mut names, mut func, block, args) = blank(&[i64, i64]);
6427 let mut build = Builder::new(&mut func, block);
6428 let four = build.iconst(i64, 4);
6429 let scaled = build.binary(Opcode::Mul, args[1], four, Flags::default());
6430 build.binary(Opcode::Add, args[0], scaled, Flags::default());
6431 build.store(scaled, args[0], plain(), Flags::default());
6432
6433 // The addition has room for the multiply and the store does not: what a store writes is
6434 // a register, and no rule reaches through it. Folding into the addition alone would
6435 // leave the multiply where it is for the store to read and do the work twice, so the
6436 // multiply is put back and both readers read the register it wrote.
6437 let text = lower(&mut names, &func);
6438 assert!(text.contains("x64.lea_64 [%1*4]"), "{text}");
6439 assert!(text.contains("x64.add_rr_64"), "{text}");
6440 }
6441
6442 #[test]
6443 fn a_shift_by_a_register_asks_for_it_in_cl() {
6444 let i32 = Type::int(32);
6445 let (mut names, mut func, block, args) = blank(&[i32, i32]);
6446 let mut build = Builder::new(&mut func, block);
6447 build.binary(Opcode::Shl, args[0], args[1], Flags::default());
6448
6449 // The fixed register is not in the rule. It is what the target says the instruction does
6450 // with its operands, and the allocator is what will act on it.
6451 let text = lower(&mut names, &func);
6452 assert!(text.contains("x64.shl_rcl_32 %0, %1($rcx)"), "{text}");
6453 }
6454
6455 #[test]
6456 fn a_division_names_the_registers_and_the_register_it_destroys() {
6457 let i32 = Type::int(32);
6458 let (mut names, mut func, block, args) = blank(&[i32, i32]);
6459 let mut build = Builder::new(&mut func, block);
6460 build.binary(Opcode::SDiv, args[0], args[1], Flags::default());
6461
6462 // Two definitions, because a division writes the remainder whether anybody wanted it or
6463 // not, and the second one is early because it is destroyed before the operands are read.
6464 let text = lower(&mut names, &func);
6465 assert!(
6466 text.contains("%2:gpr($rax), early %3:gpr($rdx) = x64.idiv_quo_32 %0($rax), %1"),
6467 "{text}"
6468 );
6469 }
6470
6471 #[test]
6472 fn a_load_reads_through_the_register_the_address_is_in() {
6473 let i64 = Type::int(64);
6474 let (mut names, mut func, block, args) = blank(&[i64]);
6475 let mut build = Builder::new(&mut func, block);
6476 build.load(Type::int(32), args[0], plain(), Flags::default());
6477
6478 assert_eq!(
6479 lower(&mut names, &func),
6480 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6481 %1:gpr = x64.mov_rm_32 [%0]\n}\n"
6482 );
6483 }
6484
6485 #[test]
6486 fn a_store_writes_no_register_and_the_value_it_writes_is_the_one_the_ir_gave_it() {
6487 let (mut names, mut func, block, args) = blank(&[Type::int(32), Type::int(64)]);
6488 let mut build = Builder::new(&mut func, block);
6489 build.store(args[0], args[1], plain(), Flags::default());
6490
6491 // The value is the first parameter and the address is the second, and the instruction
6492 // takes them the other way round. Getting that backwards would compile to a store of the
6493 // address into the value, which is a program that runs and does the wrong thing.
6494 assert_eq!(
6495 lower(&mut names, &func),
6496 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
6497 %1:gpr($rsi) = x64.arg_val_64\n x64.mov_mr_32 %0, [%1]\n}\n"
6498 );
6499 }
6500
6501 #[test]
6502 fn an_address_with_a_constant_added_folds_into_the_access() {
6503 let i64 = Type::int(64);
6504 let (mut names, mut func, block, args) = blank(&[i64]);
6505 let mut build = Builder::new(&mut func, block);
6506 let twelve = build.iconst(i64, 12);
6507 let field = build.binary(Opcode::Add, args[0], twelve, Flags::default());
6508 build.load(Type::int(64), field, plain(), Flags::default());
6509
6510 // Two IR instructions and one machine instruction, which is what every read of a field
6511 // of a structure comes to.
6512 assert_eq!(
6513 lower(&mut names, &func),
6514 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6515 %1:gpr = x64.mov_rm_64 [%0 + 12]\n}\n"
6516 );
6517 }
6518
6519 #[test]
6520 fn a_displacement_too_wide_to_encode_leaves_the_addition_where_it_is() {
6521 let i64 = Type::int(64);
6522 let (mut names, mut func, block, args) = blank(&[i64]);
6523 let mut build = Builder::new(&mut func, block);
6524 let big = build.iconst(i64, i128::from(i32::MAX) + 1);
6525 let far = build.binary(Opcode::Add, args[0], big, Flags::default());
6526 build.load(Type::int(32), far, plain(), Flags::default());
6527
6528 // A displacement is signed and 32 bits. The rule that folds one has a guard that turns
6529 // this down, so the addition stays and the load reads through what it produced. Nobody
6530 // wrote that fallback: it is the next way of showing the operand.
6531 let text = lower(&mut names, &func);
6532 assert!(text.contains("x64.mov_rm_32 [%2]"), "{text}");
6533 assert!(text.contains("x64.add_rr_64"), "{text}");
6534 }
6535
6536 #[test]
6537 fn a_store_of_a_value_that_was_loaded_is_two_instructions_and_no_arithmetic() {
6538 let i64 = Type::int(64);
6539 let (mut names, mut func, block, args) = blank(&[i64, i64]);
6540 let mut build = Builder::new(&mut func, block);
6541 let got = build.load(Type::int(8), args[0], plain(), Flags::default());
6542 build.store(got, args[1], plain(), Flags::default());
6543
6544 // A load feeding a store is the one place folding would be wrong: an x86-64 `mov` has at
6545 // most one memory operand, and there is no rule that takes two, so the load is left where
6546 // it is and the store reads the register it wrote.
6547 assert_eq!(
6548 lower(&mut names, &func),
6549 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6550 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr = x64.mov_rm_8 [%0]\n \
6551 x64.mov_mr_8 %2, [%1]\n}\n"
6552 );
6553 }
6554
6555 #[test]
6556 fn an_access_at_a_width_no_rule_is_written_at_is_reported() {
6557 let i64 = Type::int(64);
6558 let (mut names, mut source, block, args) = blank(&[i64]);
6559 let mut build = Builder::new(&mut source, block);
6560 build.load(Type::int(128), args[0], plain(), Flags::default());
6561
6562 // The width is the whole of what is wrong here, so the width is in the message: `load`
6563 // on its own is written about at every other width and would send a reader looking in
6564 // the wrong place.
6565 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6566 .expect_err("nothing loads 128 bits");
6567 assert_eq!(failed.to_string(), "no rule lowers a `load` producing a `i128`");
6568 }
6569
6570 #[test]
6571 fn a_return_asks_for_the_value_in_the_register_the_caller_reads() {
6572 let (mut names, mut func, block, args) = blank(&[Type::int(32)]);
6573 let mut build = Builder::new(&mut func, block);
6574 build.ret(&[args[0]]);
6575
6576 // The register is not in the rule, the same way `cl` is not in the rule for a shift. It
6577 // is what the target says the instruction does with its operand, and the allocator is
6578 // what will act on it. There is no `ret` here, because giving the frame back has to
6579 // happen between this and leaving and the frame is not worked out yet.
6580 assert_eq!(
6581 lower(&mut names, &func),
6582 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
6583 x64.ret_val_32 %0($rax)\n}\n"
6584 );
6585 }
6586
6587 #[test]
6588 fn a_return_of_two_values_asks_for_the_second_register_as_well() {
6589 let i64 = Type::int(64);
6590 let (mut names, mut func, block, args) = blank(&[i64, i64]);
6591 let mut build = Builder::new(&mut func, block);
6592 build.ret(&[args[0], args[1]]);
6593
6594 // `struct { long a, b; } f(long a, long b)`, after the front end has classified it. Both
6595 // halves are integers, so the second is in the second integer return register, and both
6596 // pseudos say so the same way the one for a single value does.
6597 assert_eq!(
6598 lower(&mut names, &func),
6599 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6600 %1:gpr($rsi) = x64.arg_val_64\n x64.ret_val_64 %0($rax)\n \
6601 x64.ret_val2_64 %1($rdx)\n}\n"
6602 );
6603 }
6604
6605 #[test]
6606 fn two_values_back_in_different_files_are_both_the_first_of_their_own() {
6607 let f64 = Type::float(rucc_ir::Float::F64);
6608 let (mut names, mut func, block, args) = blank(&[f64, Type::int(64)]);
6609 let mut build = Builder::new(&mut func, block);
6610 build.ret(&[args[0], args[1]]);
6611
6612 // `struct { double a; long b; } f(double a, long b)`. The two files are counted apart, so
6613 // neither half is the second of anything and the `double` is in `xmm0` rather than in the
6614 // register a second `double` would have been in. Getting this wrong is not a crash: the
6615 // caller reads a register nobody wrote, and this is where that is ruled out.
6616 assert_eq!(
6617 lower(&mut names, &func),
6618 "mfunc @f {\nblock0:\n %0:xmm($xmm0) = x64.arg_val_f64\n \
6619 %1:gpr($rdi) = x64.arg_val_64\n x64.ret_val_f64 %0($xmm0)\n \
6620 x64.ret_val_64 %1($rax)\n}\n"
6621 );
6622 }
6623
6624 #[test]
6625 fn two_of_the_same_file_back_take_the_first_two_of_it() {
6626 let f64 = Type::float(rucc_ir::Float::F64);
6627 let (mut names, mut func, block, args) = blank(&[f64, f64]);
6628 let mut build = Builder::new(&mut func, block);
6629 build.ret(&[args[0], args[1]]);
6630
6631 // `struct { double x, y; } f(double x, double y)`, which is the vector half of the pair
6632 // above and counts in its own file the same way.
6633 assert_eq!(
6634 lower(&mut names, &func),
6635 "mfunc @f {\nblock0:\n %0:xmm($xmm0) = x64.arg_val_f64\n \
6636 %1:xmm($xmm1) = x64.arg_val_f64\n x64.ret_val_f64 %0($xmm0)\n \
6637 x64.ret_val2_f64 %1($xmm1)\n}\n"
6638 );
6639 }
6640
6641 /// A function whose answer goes back through memory, with the pointer to the space for it in
6642 /// front of whatever else it takes. Only the signature says it is one.
6643 fn returning_through_memory(params: &[Type]) -> (Interner, Func, Block, Vec<Value>) {
6644 let mut names = Interner::new();
6645 let sret = Abi::Sret { size: 32, align: 8 };
6646 let mut signature = Signature::new().and_param(Param::with_abi(Type::PTR, sret));
6647 signature.params.extend(params.iter().copied().map(Param::new));
6648 let mut func = Func::new(names.intern("f"), signature);
6649 let block = func.create_block();
6650 let space = func.append_param(block, Type::PTR);
6651 let values = std::iter::once(space)
6652 .chain(params.iter().map(|&ty| func.append_param(block, ty)))
6653 .collect();
6654 (names, func, block, values)
6655 }
6656
6657 #[test]
6658 fn the_space_a_return_through_memory_was_given_goes_back_in_the_first_return_register() {
6659 let (mut names, mut func, block, _) = returning_through_memory(&[]);
6660 Builder::new(&mut func, block).ret(&[]);
6661
6662 // `struct big f(void)`, where `big` is too large to come back in registers. The `return`
6663 // carries nothing, because the value went into the space the caller handed over, and the
6664 // document still says that address comes back in `rax`. Nothing in the IR says it, so the
6665 // convention says it, and the pseudo is the one any other pointer return would use.
6666 assert_eq!(
6667 lower(&mut names, &func),
6668 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
6669 x64.ret_val_64 %0($rax)\n}\n"
6670 );
6671 }
6672
6673 #[test]
6674 fn what_the_function_did_in_between_does_not_take_the_register_off_it() {
6675 let (mut names, mut func, block, args) = returning_through_memory(&[Type::int(32)]);
6676 let mut build = Builder::new(&mut func, block);
6677 build.store(args[1], args[0], plain(), Flags::default());
6678 build.ret(&[]);
6679
6680 // The register is a read at the end and not a move at the start, so it is live across
6681 // everything between the two and the allocator has to keep it somewhere. In a function
6682 // with a call in it that somewhere is a callee saved register, and the address comes back
6683 // into `rax` here rather than whatever the last instruction happened to leave there. That
6684 // is issue #333, and a store is enough to show the value outlives the entry block.
6685 let text = lower(&mut names, &func);
6686 assert!(text.contains("x64.mov_mr_32 %1, [%0]"), "{text}");
6687 assert!(text.ends_with(" x64.ret_val_64 %0($rax)\n}\n"), "{text}");
6688 }
6689
6690 #[test]
6691 fn a_pointer_that_is_only_a_pointer_is_not_given_back() {
6692 let (mut names, mut func, block, args) = blank(&[Type::PTR]);
6693 let mut build = Builder::new(&mut func, block);
6694 build.store(args[0], args[0], plain(), Flags::default());
6695 build.ret(&[]);
6696
6697 // `void f(void **p)`. It takes a pointer first and returns nothing, which is the shape of
6698 // the one above and none of its meaning, and what tells them apart is the signature. A
6699 // `void` function leaves `rax` alone.
6700 assert!(!lower(&mut names, &func).contains("ret_val"));
6701 }
6702
6703 #[test]
6704 fn a_return_of_a_constant_puts_it_in_a_register_first() {
6705 let (mut names, mut func, block, _) = blank(&[]);
6706 let mut build = Builder::new(&mut func, block);
6707 let zero = build.iconst(Type::int(32), 0);
6708 build.ret(&[zero]);
6709
6710 // No rule returns an immediate, so the plan that offers one is turned down and the next
6711 // one materializes it. That is `int main(void) { return 0; }` in full, once the epilogue
6712 // is appended to it.
6713 assert_eq!(
6714 lower(&mut names, &func),
6715 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n x64.ret_val_32 %0($rax)\n}\n"
6716 );
6717 }
6718
6719 #[test]
6720 fn the_rule_that_writes_a_constant_down_is_recorded_as_a_rule_that_fired() {
6721 let (mut names, mut func, block, _) = blank(&[]);
6722 let mut build = Builder::new(&mut func, block);
6723 let zero = build.iconst(Type::int(32), 0);
6724 build.ret(&[zero]);
6725
6726 // The loop over the instructions passes a constant by, because a constant is written where
6727 // a register for it is first wanted rather than where the IR put it. So the only place a
6728 // rule about one is ever selected is the materialization, and a mark made in the loop
6729 // alone would report every rule about a constant as a rule nothing reaches.
6730 let out = super::func(&func, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6731 .expect("every instruction has a rule");
6732 let rules = &crate::select::x86_64::TABLE.rules;
6733 let fired: Vec<&str> = rules
6734 .iter()
6735 .enumerate()
6736 .filter(|(index, _)| out.fired.has(*index))
6737 .map(|(_, rule)| rule.pattern)
6738 .collect();
6739 assert!(fired.contains(&"(iconst.i32 k)"), "{fired:?}");
6740 }
6741
6742 #[test]
6743 fn a_return_of_nothing_is_no_instruction_at_all() {
6744 let (mut names, mut func, block, _) = blank(&[]);
6745 let mut build = Builder::new(&mut func, block);
6746 build.ret(&[]);
6747
6748 // Every part of leaving a function that returns nothing is the epilogue's, and the
6749 // epilogue goes in after allocation. A block with nothing in it is the right answer here
6750 // rather than a function that could not be lowered.
6751 assert_eq!(lower(&mut names, &func), "mfunc @f {\nblock0:\n}\n");
6752 }
6753
6754 #[test]
6755 fn the_allocator_is_what_moves_the_answer_into_the_return_register() {
6756 let (mut names, mut source, block, _) = blank(&[]);
6757 let mut build = Builder::new(&mut source, block);
6758 let zero = build.iconst(Type::int(32), 0);
6759 build.ret(&[zero]);
6760
6761 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6762 .expect("every instruction has a rule")
6763 .func;
6764 let env = env();
6765 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6766 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
6767 finish(
6768 &mut out,
6769 &allocation,
6770 &frame,
6771 &Stack::default(),
6772 Convention::new(&SYSV, &FRAME),
6773 &mut names,
6774 );
6775
6776 // `int main(void) { return 0; }` end to end. Nothing here asked for `rax`: the rule said
6777 // the value goes back, the target said where, and the allocator is what made it true. The
6778 // epilogue is what leaves, and this function needs no frame, so it is the return alone.
6779 //
6780 // Two instructions and no copy, which is what a hint buys. The return insists on `rax`,
6781 // so `rax` is the register the allocator tries first for the value the return reads, and
6782 // the constant is written straight into it.
6783 assert_eq!(
6784 mir::print_func(&out, &names, ®S),
6785 "mfunc @f {\nblock0:\n $rax = x64.mov_ri_32 0\n \
6786 x64.ret_val_32 $rax($rax)\n x64.ret\n}\n"
6787 );
6788 }
6789
6790 #[test]
6791 fn a_function_of_two_arguments_is_a_whole_function_now() {
6792 let i32 = Type::int(32);
6793 let (mut names, mut source, block, args) = blank(&[i32, i32]);
6794 let mut build = Builder::new(&mut source, block);
6795 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
6796 build.ret(&[sum]);
6797
6798 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6799 .expect("every instruction has a rule")
6800 .func;
6801 let env = env();
6802 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6803 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
6804 finish(
6805 &mut out,
6806 &allocation,
6807 &frame,
6808 &Stack::default(),
6809 Convention::new(&SYSV, &FRAME),
6810 &mut names,
6811 );
6812
6813 // `int f(int a, int b) { return a + b; }` end to end, and this is the test the argument
6814 // side exists for. Before it there was no way to write one: the allocator refuses a
6815 // function whose entry block takes parameters, because there is no edge into an entry
6816 // block for the moves that give a block parameter its value to go on.
6817 //
6818 // One move, and it is the one the machine's addition needs rather than one the allocator
6819 // owes anybody. Each argument stays in the register it arrived in, because the pseudo
6820 // that defines it insists on that register and the allocator now tries it first, and the
6821 // sum stays in the register the addition wrote it to until the return reads it out. The
6822 // copy in front of a two address instruction is what makes its destination one of the
6823 // registers it reads, and the source operand keeps its own name because the destination
6824 // is what the encoder writes.
6825 assert_eq!(
6826 mir::print_func(&out, &names, ®S),
6827 "mfunc @f {\nblock0:\n $rdi($rdi) = x64.arg_val_32\n \
6828 $rsi($rsi) = x64.arg_val_32\n \
6829 $rdi(reuse 1) = x64.add_rr_32 $rdi, $rsi\n $rax = x64.mov_rr_64 $rdi\n \
6830 x64.ret_val_32 $rax($rax)\n x64.ret\n}\n"
6831 );
6832 }
6833
6834 #[test]
6835 fn an_argument_with_no_register_left_for_it_is_read_out_of_the_caller_s_stack() {
6836 let i64 = Type::int(64);
6837 let (mut names, mut source, block, args) = blank(&[i64; 7]);
6838 let mut build = Builder::new(&mut source, block);
6839 build.ret(&[args[6]]);
6840
6841 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6842 .expect("the seventh is read from memory");
6843
6844 // SysV passes six integers in registers and the seventh in the caller's memory, so six of
6845 // these are pseudos that encode to nothing and the seventh is a load that encodes to real
6846 // bytes. Its displacement is nothing here for the reason a local's is: there is no frame
6847 // yet. What the walk hands on is which instruction is waiting, and for how far up the
6848 // caller's argument area, which is the bottom of it because it is the first one there.
6849 assert_eq!(lowered.stack.arguments.len(), 1);
6850 assert_eq!(lowered.stack.arguments[0].1, 0);
6851 let text = mir::print_func(&lowered.func, &names, ®S);
6852 assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
6853 assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
6854 }
6855
6856 #[test]
6857 fn the_frame_is_what_says_how_far_up_the_caller_s_stack_an_argument_is() {
6858 let i64 = Type::int(64);
6859 let (mut names, mut source, block, args) = blank(&[i64; 8]);
6860 let mut build = Builder::new(&mut source, block);
6861 let sum = build.binary(Opcode::Add, args[6], args[7], Flags::default());
6862 build.ret(&[sum]);
6863
6864 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6865 .expect("both are read from memory");
6866 let stack = lowered.stack;
6867 let mut out = lowered.func;
6868 let env = env();
6869 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6870 let layout = stack.layout(Layout::new(&SYSV, REGS));
6871 let frame = Frame::of(&out, &allocation, &layout);
6872 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
6873
6874 // A leaf that takes no frame, so the stack pointer never moves and the only thing between
6875 // it and the caller's arguments is the return address the call pushed. The seventh
6876 // parameter is at the bottom of the caller's argument area and the eighth is one word
6877 // further up, which is the eight bytes between the two offsets.
6878 let text = mir::print_func(&out, &names, ®S);
6879 assert_eq!(frame.size(), 0);
6880 assert_eq!(frame.incoming(), Incoming::from_stack(8));
6881 assert!(text.contains("x64.mov_rm_64 [$rsp + 8]"), "{text}");
6882 assert!(text.contains("x64.mov_rm_64 [$rsp + 16]"), "{text}");
6883 }
6884
6885 #[test]
6886 fn a_realigned_frame_reaches_the_caller_s_arguments_through_the_frame_pointer() {
6887 let i64 = Type::int(64);
6888 let (mut names, mut source, block, args) = blank(&[i64; 7]);
6889 let wide = slot(&mut source, block, 64, 32);
6890 let mut build = Builder::new(&mut source, block);
6891 build.store(args[6], wide, plain(), Flags::default());
6892 build.ret(&[args[6]]);
6893
6894 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
6895 .expect("every instruction has a rule");
6896 let stack = lowered.stack;
6897 let mut out = lowered.func;
6898 let env = env();
6899 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
6900 let layout = stack.layout(Layout::new(&SYSV, REGS));
6901 let frame = Frame::of(&out, &allocation, &layout);
6902 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
6903
6904 // A local wanting thirty two byte alignment makes the prologue force the stack pointer,
6905 // which throws away how far the caller's stack was. So the load the lowering wrote off the
6906 // stack pointer is rewritten to read through the frame pointer, at the one distance that
6907 // survives: the word the prologue pushed the frame pointer into, and the return address
6908 // above it.
6909 let text = mir::print_func(&out, &names, ®S);
6910 assert_eq!(frame.realign(), Some(32));
6911 assert_eq!(frame.incoming(), Incoming::from_frame(16));
6912 assert!(text.contains("x64.mov_rm_64 [$rbp + 16]"), "{text}");
6913 assert!(!text.contains("x64.mov_rm_64 [$rsp"), "{text}");
6914 }
6915
6916 #[test]
6917 fn a_jump_is_the_edge_and_nothing_else() {
6918 let i32 = Type::int(32);
6919 let (mut names, mut source, entry, args) = blank(&[i32]);
6920 let next = source.create_block();
6921 let got = source.append_param(next, i32);
6922 Builder::new(&mut source, entry).jump(next, &[args[0]]);
6923 Builder::new(&mut source, next).ret(&[got]);
6924
6925 // Two blocks and two instructions, and the jump is neither of them. What it was is the
6926 // arm on the first block, and what the arm carries is the argument it was called with.
6927 assert_eq!(
6928 lower(&mut names, &source),
6929 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32 block1(%0)\n\n\
6930 block1(%1:gpr):\n x64.ret_val_32 %1($rax)\n}\n"
6931 );
6932 }
6933
6934 /// A block that reads what a block below it writes is filled after it, not before it.
6935 ///
6936 /// The blocks are written entry, `early`, `late`, `exit`, and the entry jumps straight past
6937 /// `early` to `late`, so `late` dominates `early` while sitting below it in the function.
6938 /// Filling them in the order they are written reaches the read in `early` first, and reading
6939 /// a value with no register yet mints one. The cast in `late` is no instruction at all, so
6940 /// what it does is give its answer the register its operand is already in, and that is not
6941 /// the register the read minted. Nothing writes the register the read minted. The printer
6942 /// says `%?` for a register nothing defines, which is what this looks for, and what came out
6943 /// of the real bug was SQLite loading a stack slot no store ever reached.
6944 #[test]
6945 fn a_block_that_reads_what_a_block_below_it_writes_is_filled_after_it() {
6946 let i64 = Type::int(64);
6947 let (mut names, mut source, entry, args) = blank(&[i64, i64]);
6948 let early = source.create_block();
6949 let late = source.create_block();
6950 let exit = source.create_block();
6951
6952 Builder::new(&mut source, entry).jump(late, &[]);
6953 let ptr = cast(&mut source, late, Opcode::IntToPtr, args[0], Type::PTR);
6954 Builder::new(&mut source, early).ret(&[ptr]);
6955 let mut build = Builder::new(&mut source, late);
6956 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
6957 build.br_if(cond, early, &[], exit, &[]);
6958 Builder::new(&mut source, exit).ret(&[args[1]]);
6959
6960 let text = lower(&mut names, &source);
6961 assert!(!text.contains("%?"), "every register has something that writes it: {text}");
6962 }
6963
6964 /// A constant is written where it is wanted rather than where the IR defined it, and two
6965 /// blocks wanting the same one is two places. Writing it once and reading it in both is a
6966 /// register read where nothing wrote it, unless the block it was written in happens to
6967 /// dominate the other, which nothing here checks and which the second arm of a branch never
6968 /// does. Each block gets its own copy of the number instead.
6969 #[test]
6970 fn a_constant_two_blocks_want_is_written_in_both_of_them() {
6971 let i32 = Type::int(32);
6972 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
6973 let then = source.create_block();
6974 let other = source.create_block();
6975 let join = source.create_block();
6976 let got = source.append_param(join, i32);
6977
6978 let mut build = Builder::new(&mut source, entry);
6979 let seven = build.iconst(i32, 7);
6980 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
6981 build.br_if(cond, then, &[], other, &[]);
6982 // Both arms want the seven in a register, because a block argument is never an immediate,
6983 // and neither arm dominates the other.
6984 Builder::new(&mut source, then).jump(join, &[seven]);
6985 Builder::new(&mut source, other).jump(join, &[seven]);
6986 Builder::new(&mut source, join).ret(&[got]);
6987
6988 let text = lower(&mut names, &source);
6989 assert_eq!(text.matches("x64.mov_ri_32 7").count(), 2, "one seven per block: {text}");
6990 }
6991
6992 /// An argument on an edge out of a block that leaves two ways is read after every instruction
6993 /// of the block is written, and reading one can write an instruction, which would land after
6994 /// the branch that has already jumped past it. The branch goes back on the end.
6995 #[test]
6996 fn a_constant_an_edge_wants_is_written_before_the_branch_and_not_after_it() {
6997 let i32 = Type::int(32);
6998 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
6999 let then = source.create_block();
7000 let join = source.create_block();
7001 let got = source.append_param(join, i32);
7002
7003 let mut build = Builder::new(&mut source, entry);
7004 let nine = build.iconst(i32, 9);
7005 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7006 build.br_if(cond, then, &[], join, &[nine]);
7007 Builder::new(&mut source, then).jump(join, &[args[0]]);
7008 Builder::new(&mut source, join).ret(&[got]);
7009
7010 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7011 .expect("every instruction has a rule")
7012 .func;
7013 let entry = out.entry().expect("an entry block");
7014 let last = out.terminator(entry).expect("a block that leaves two ways has a branch");
7015 let branch = names.intern("x64.br_cond_8");
7016 assert_eq!(
7017 out[last].opcode,
7018 mir::Opcode::new(branch),
7019 "the branch is last: {}",
7020 mir::print_func(&out, &names, ®S)
7021 );
7022 }
7023
7024 #[test]
7025 fn a_conditional_branch_is_lowered_to_the_condition_and_nothing_about_where_it_goes() {
7026 let i32 = Type::int(32);
7027 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7028 let then = source.create_block();
7029 let other = source.create_block();
7030 let mut build = Builder::new(&mut source, entry);
7031 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7032 build.br_if(cond, then, &[], other, &[]);
7033 Builder::new(&mut source, then).ret(&[args[0]]);
7034 Builder::new(&mut source, other).ret(&[args[1]]);
7035
7036 // The comparison writes a byte and the branch reads it, and neither says a block. Both
7037 // arms are on the entry block, in the order the branch took them, so the arm that runs
7038 // when the condition holds is the first.
7039 assert_eq!(
7040 lower(&mut names, &source),
7041 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7042 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr = x64.cmp_set_l_32 %0, %1\n \
7043 x64.br_cond_8 %2, block1, block2\n\n\
7044 block1:\n x64.ret_val_32 %0($rax)\n\n\
7045 block2:\n x64.ret_val_32 %1($rax)\n}\n"
7046 );
7047 }
7048
7049 /// A choice between two values, which is one instruction and no blocks at all.
7050 ///
7051 /// The arms come out the other way round from the IR, because a conditional move overwrites its
7052 /// destination and the destination is the arm taken when the condition does not hold. The
7053 /// condition arrives last for the same reason: it is read by the test in front of the move
7054 /// rather than by the move.
7055 #[test]
7056 fn a_select_is_lowered_to_a_test_and_a_conditional_move() {
7057 let i32 = Type::int(32);
7058 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7059 let mut build = Builder::new(&mut source, entry);
7060 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7061 let picked = build.select(cond, args[0], args[1]);
7062 build.ret(&[picked]);
7063
7064 assert_eq!(
7065 lower(&mut names, &source),
7066 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
7067 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr = x64.cmp_set_l_32 %0, %1\n \
7068 %3:gpr(reuse 1) = x64.test_cmov_ne_32 %1, %0, %2\n \
7069 x64.ret_val_32 %3($rax)\n}\n"
7070 );
7071 }
7072
7073 #[test]
7074 fn a_branch_over_a_block_is_a_whole_function_now() {
7075 let i32 = Type::int(32);
7076 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7077 let then = source.create_block();
7078 let other = source.create_block();
7079 let join = source.create_block();
7080 let got = source.append_param(join, i32);
7081 let mut build = Builder::new(&mut source, entry);
7082 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7083 build.br_if(cond, then, &[], other, &[]);
7084 let mut build = Builder::new(&mut source, then);
7085 let sum = build.binary(Opcode::Add, args[0], args[1], Flags::default());
7086 build.jump(join, &[sum]);
7087 Builder::new(&mut source, other).jump(join, &[args[1]]);
7088 Builder::new(&mut source, join).ret(&[got]);
7089
7090 // `int f(int a, int b) { if (a < b) return a + b; else return b; }` end to end, written
7091 // the way a front end writes it: both arms of the branch are blocks of their own and the
7092 // return is the block they meet at. No edge here is critical, because the two arms out of
7093 // the entry carry nothing and the two arms into the join each leave a block that goes
7094 // nowhere else, so each has its own end to put its move at.
7095 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7096 .expect("every instruction has a rule")
7097 .func;
7098 assert_eq!(crate::split::critical(&mut out), 0, "no edge here is critical");
7099 let env = env();
7100 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7101 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7102 finish(
7103 &mut out,
7104 &allocation,
7105 &frame,
7106 &Stack::default(),
7107 Convention::new(&SYSV, &FRAME),
7108 &mut names,
7109 );
7110
7111 // One epilogue, on the join, which is the one block the function leaves from, and the
7112 // moves that give the join its parameter are at the end of each arm. Every register is
7113 // physical and the branch is still a branch on a register, because turning it into a
7114 // `test` and a `jcc` is the block layout's and there is no block layout yet.
7115 let text = mir::print_func(&out, &names, ®S);
7116 assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7117 assert!(text.contains("x64.br_cond_8"), "{text}");
7118 assert!(text.contains("x64.add_rr_32"), "{text}");
7119 assert!(!text.contains('%'), "{text}");
7120 }
7121
7122 #[test]
7123 fn a_critical_edge_is_split_before_the_allocator_ever_sees_it() {
7124 let i32 = Type::int(32);
7125 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7126 let then = source.create_block();
7127 let join = source.create_block();
7128 let got = source.append_param(join, i32);
7129 let mut build = Builder::new(&mut source, entry);
7130 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7131 build.br_if(cond, then, &[], join, &[args[1]]);
7132 Builder::new(&mut source, then).jump(join, &[args[0]]);
7133 let mut build = Builder::new(&mut source, join);
7134 let twice = build.binary(Opcode::Add, got, got, Flags::default());
7135 build.ret(&[twice]);
7136
7137 // The else arm is critical: the entry block leaves two ways and the join is arrived at
7138 // two ways, and the arm carries a value. Without splitting it the allocator asserts,
7139 // because the move that gives the join its parameter would have to run at the end of a
7140 // block that also goes to the other arm.
7141 let mut out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7142 .expect("every instruction has a rule")
7143 .func;
7144 assert_eq!(crate::split::critical(&mut out), 1);
7145 let env = env();
7146 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7147 let frame = Frame::of(&out, &allocation, &Layout::new(&SYSV, REGS));
7148 finish(
7149 &mut out,
7150 &allocation,
7151 &frame,
7152 &Stack::default(),
7153 Convention::new(&SYSV, &FRAME),
7154 &mut names,
7155 );
7156
7157 // The block the split added is where the move went, and it is the whole of that block.
7158 let text = mir::print_func(&out, &names, ®S);
7159 assert_eq!(out.block_count(), 4, "{text}");
7160 assert_eq!(text.matches("x64.ret\n").count(), 1, "{text}");
7161 }
7162
7163 #[test]
7164 fn a_call_passes_what_the_convention_says_and_takes_back_what_it_says() {
7165 let i32 = Type::int(32);
7166 let (mut names, mut source, block, args) = blank(&[i32, i32]);
7167 let sig =
7168 source.add_signature(Signature::new().with_params(&[i32, i32]).with_returns(&[i32]));
7169 let callee = names.intern("g");
7170 let call = Builder::new(&mut source, block).call(callee, sig, &[args[0], args[1]]);
7171 let got = source[call].first_result.expect("an integer comes back");
7172 Builder::new(&mut source, block).ret(&[got]);
7173
7174 // `int f(int a, int b) { return g(a, b); }`. The arguments arrived where the call wants
7175 // them, so what the call reads is what arrived, and the whole of the convention is in the
7176 // constraints rather than in a move.
7177 let text = lower(&mut names, &source);
7178 assert!(text.contains("= x64.call %0($rdi), %1($rsi), @g"), "{text}");
7179 assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7180 // What the call writes is the value that comes back and then every register the callee is
7181 // free to destroy, in both classes, which is the whole of what stops the allocator from
7182 // leaving something in one of them.
7183 assert!(text.contains("%2:gpr($rax), $rcx, $rdx, $r8, $r9, $r10, $r11, $xmm0,"), "{text}");
7184 assert!(text.contains("$xmm15 = x64.call"), "{text}");
7185 }
7186
7187 #[test]
7188 fn what_the_frame_owes_a_call_comes_back_with_the_function() {
7189 let i32 = Type::int(32);
7190 let sig = |source: &mut Func| source.add_signature(Signature::new().with_params(&[i32]));
7191
7192 let (mut names, mut source, block, args) = blank(&[i32]);
7193 let sig = sig(&mut source);
7194 let callee = names.intern("g");
7195 Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7196 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7197 .expect("every instruction has a rule");
7198
7199 // Nothing on the stack, so nothing owed, but not a leaf either: a function that calls
7200 // owes the callee an aligned stack pointer and may not use the red zone.
7201 assert_eq!(out.stack.calls, Some(0));
7202 let layout = out.stack.layout(Layout::new(&SYSV, REGS));
7203 assert!(!layout.leaf);
7204 assert_eq!(layout.outgoing, 0);
7205
7206 // The same call under the other convention owes thirty two bytes for the callee to spill
7207 // its register arguments into, which is a fact about the convention and not about the call.
7208 let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7209 .expect("every instruction has a rule");
7210 assert_eq!(out.stack.calls, Some(32));
7211
7212 // And a function that calls nothing is a leaf, which is what says it may use the red zone.
7213 let (mut names, mut source, block, args) = blank(&[i32]);
7214 Builder::new(&mut source, block).ret(&[args[0]]);
7215 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7216 .expect("every instruction has a rule");
7217 assert_eq!(out.stack.calls, None);
7218 assert!(out.stack.layout(Layout::new(&SYSV, REGS)).leaf);
7219 }
7220
7221 /// A Windows variadic prologue writes the argument registers the signature did not name into
7222 /// the shadow space the caller already reserved, which makes every argument one run of words up
7223 /// there and a `va_start` the address of the first of them. One `lea` and one store, and no
7224 /// counts, because a list that is a pointer has nowhere to put one and nothing that reads one.
7225 #[test]
7226 fn a_windows_variadic_function_homes_its_spare_registers_in_the_callers_area() {
7227 let mut names = Interner::new();
7228 let params = [Type::int(32), Type::PTR];
7229 let signature = Signature::new().with_params(¶ms).variadic();
7230 let mut source = Func::new(names.intern("f"), signature);
7231 let block = source.create_block();
7232 let values: Vec<Value> = params.iter().map(|&ty| source.append_param(block, ty)).collect();
7233 let mut build = Builder::new(&mut source, block);
7234 let args = build.func().push_values(&values[1..]);
7235 build.inst(InstData { args, ..InstData::new(Opcode::VaStart) }, &[]);
7236 build.ret(&[]);
7237
7238 let out = func(&source, &mut names, &SELECTOR, &x86_64::WIN64, &Elsewhere::default())
7239 .expect("every instruction has a rule");
7240 let text = mir::print_func(&out.func, &names, ®S);
7241
7242 // Two named parameters, so the registers at the next two positions hold arguments nobody
7243 // named and both are written up into the caller's area. The displacement is empty here and
7244 // `finish` fills it in, the same way it does for a parameter the registers ran out before.
7245 assert!(text.contains("($r8) = x64.arg_val_64"), "{text}");
7246 assert!(text.contains("($r9) = x64.arg_val_64"), "{text}");
7247 assert_eq!(text.matches("x64.mov_mr_64").count(), 3, "two homed and one stored: {text}");
7248 assert!(!text.contains("x64.mov_ri_32"), "and no field holds a count: {text}");
7249
7250 // All three waiting on the same fixup, and the last of them is the `lea` the list is given,
7251 // sixteen bytes up, which is where the two arguments the signature does name stopped.
7252 assert_eq!(out.stack.arguments.len(), 3);
7253 assert_eq!(out.stack.arguments[2].1, 16);
7254 }
7255
7256 #[test]
7257 fn a_value_that_outlives_a_call_is_not_left_where_the_call_destroys_it() {
7258 let i32 = Type::int(32);
7259 let (mut names, mut source, block, args) = blank(&[i32]);
7260 let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7261 let callee = names.intern("g");
7262 let call = Builder::new(&mut source, block).call(callee, sig, &[args[0]]);
7263 let got = source[call].first_result.expect("an integer comes back");
7264 let mut build = Builder::new(&mut source, block);
7265 let sum = build.binary(Opcode::Add, got, args[0], Flags::default());
7266 build.ret(&[sum]);
7267
7268 // `int f(int a) { return g(a) + a; }`, which is the smallest program that asks the
7269 // question: `a` is read after the call and `rdi` is a register the call destroys.
7270 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7271 .expect("every instruction has a rule");
7272 let layout = lowered.stack.layout(Layout::new(&SYSV, REGS));
7273 let mut out = lowered.func;
7274 let env = env();
7275 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7276 let frame = Frame::of(&out, &allocation, &layout);
7277 finish(
7278 &mut out,
7279 &allocation,
7280 &frame,
7281 &Stack::default(),
7282 Convention::new(&SYSV, &FRAME),
7283 &mut names,
7284 );
7285
7286 // It went to a register the callee has to put back, and the prologue and epilogue are what
7287 // put it back, which is the whole bargain the two halves of a convention make.
7288 let text = mir::print_func(&out, &names, ®S);
7289 assert!(text.contains("$rbx"), "{text}");
7290 assert!(!text.contains('%'), "{text}");
7291 assert_eq!(text.matches("x64.call").count(), 1, "{text}");
7292 }
7293
7294 #[test]
7295 fn a_call_with_more_arguments_than_registers_writes_the_rest_into_the_outgoing_area() {
7296 let i64 = Type::int(64);
7297 let (mut names, mut source, block, args) = blank(&[i64]);
7298 let seven = vec![i64; 7];
7299 let sig = source.add_signature(Signature::new().with_params(&seven));
7300 let callee = names.intern("g");
7301 let passed = vec![args[0]; 7];
7302 Builder::new(&mut source, block).call(callee, sig, &passed);
7303
7304 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7305 .expect("the seventh goes to memory");
7306 // The bytes the call needs are on the layout the frame is worked out from, so that the
7307 // frame reserves as many as the widest call in the function asked for.
7308 assert_eq!(lowered.stack.calls, Some(8));
7309 let text = mir::print_func(&lowered.func, &names, ®S);
7310 assert!(text.contains("x64.mov_mr_64 %0, [$rsp]\n"), "{text}");
7311 }
7312
7313 #[test]
7314 fn a_call_this_cannot_make_is_reported_rather_than_made() {
7315 let (mut names, mut source, block, _) = blank(&[]);
7316 let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
7317 let sig = source.add_signature(Signature::new().with_returns(&returns));
7318 let callee = names.intern("g");
7319 Builder::new(&mut source, block).call(callee, sig, &[]);
7320 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7321 .expect_err("a long double is on the x87");
7322 assert_eq!(failed.to_string(), "what this call gives back is on the x87 stack");
7323 }
7324
7325 /// A `long double` on its own is a different answer, because on its own it comes back on the
7326 /// x87 stack rather than in a register, which is somewhere the call cannot be said to write.
7327 ///
7328 /// So the call gives back nothing at all and the value is taken off the stack by the `fstp`
7329 /// straight after it. That instruction has to be straight after it: the stack is one place and
7330 /// anything else that touched it before this ran would be looking at the value still on it.
7331 #[test]
7332 fn a_call_that_gives_back_a_long_double_takes_it_off_the_stack_at_once() {
7333 let (mut names, mut source, block, _) = blank(&[]);
7334 let long_double = Type::float(rucc_ir::Float::F80);
7335 let sig = source.add_signature(Signature::new().with_returns(&[long_double]));
7336 let callee = names.intern("g");
7337 Builder::new(&mut source, block).call(callee, sig, &[]);
7338
7339 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7340 .expect("the value comes back in st0");
7341 let text = mir::print_func(&lowered.func, &names, ®S);
7342 let after: Vec<&str> =
7343 text.lines().skip_while(|line| !line.contains("x64.call")).skip(1).collect();
7344 assert_eq!(after[0].trim(), "%0:gpr = x64.lea_64 [$rsp]", "{text}");
7345 assert_eq!(after[1].trim(), "x64.fstp_t [%0]", "{text}");
7346 // And the slot it went into is the sixteen bytes the type takes, like every other one.
7347 assert_eq!(lowered.stack.locals.len(), 1, "{text}");
7348 assert_eq!(lowered.stack.locals[0].size, X87_BYTES);
7349 }
7350
7351 #[test]
7352 fn a_call_through_an_address_goes_through_the_register_the_address_is_in() {
7353 let i32 = Type::int(32);
7354 let (mut names, mut source, block, args) = blank(&[Type::PTR, i32]);
7355 let sig = source.add_signature(Signature::new().with_params(&[i32]).with_returns(&[i32]));
7356 let varargs = source.push_abis(&[]);
7357 let info = source.add_call(CallInfo { callee: None, signature: sig, varargs });
7358 let mut build = Builder::new(&mut source, block);
7359 let inst = InstData {
7360 args: build.func().push_values(&[args[0], args[1]]),
7361 extra: Extra::Call(info),
7362 ..InstData::new(Opcode::CallIndirect)
7363 };
7364 let called = build.inst(inst, &[i32]);
7365 let got = source[called].first_result.expect("an integer comes back");
7366 Builder::new(&mut source, block).ret(&[got]);
7367
7368 // `int f(int (*g)(int), int a) { return g(a); }`. The first operand is the address and
7369 // the arguments are the ones behind it, and everything else about the call is what a call
7370 // to a name would have been.
7371 let text = lower(&mut names, &source);
7372 assert!(text.contains("= x64.call_reg %0, %1($rdi)"), "{text}");
7373 assert!(text.contains("x64.ret_val_32 %2($rax)"), "{text}");
7374 assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
7375 }
7376
7377 #[test]
7378 fn an_instruction_no_rule_covers_is_reported() {
7379 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
7380 let mut build = Builder::new(&mut source, block);
7381 let operands = build.func().push_values(&[args[0]]);
7382 build.inst(InstData { args: operands, ..InstData::new(Opcode::MetaBegin) }, &[]);
7383
7384 // The mark that an object has come into being, which nothing writes an instruction for
7385 // yet: what it needs is a write over a range of the lifetime plane, and that is
7386 // `tamnd/rucc#856`. Nothing about it is a width or a register, so there is nothing for the
7387 // message to add beyond the name.
7388 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7389 .expect_err("no rule writes the beginning of a lifetime");
7390 assert_eq!(failed.to_string(), "no rule lowers a `meta_begin`");
7391
7392 // It produces nothing, so there is no type in the message and nothing invents one, and the
7393 // instruction comes back so a caller can ask the function where it was.
7394 let inst = failed.inst().expect("the instruction it is about");
7395 assert_eq!(source[inst].opcode, Opcode::MetaBegin);
7396 }
7397
7398 /// A barrier is written by name here, and what it is depends on the ordering and on nothing
7399 /// else. `crate::expand` is where the reasoning about this machine's memory model lives.
7400 #[test]
7401 fn a_barrier_is_one_instruction_at_the_strongest_ordering_and_none_below_it() {
7402 for order in MemOrder::all().filter(|&order| order != MemOrder::NotAtomic) {
7403 let (mut names, mut source, block, _) = blank(&[]);
7404 let mut build = Builder::new(&mut source, block);
7405 build
7406 .inst(InstData { extra: Extra::Order(order), ..InstData::new(Opcode::Fence) }, &[]);
7407
7408 let text = lower(&mut names, &source);
7409 assert_eq!(text.contains("x64.mfence"), order == MemOrder::SeqCst, "{order:?}: {text}");
7410 }
7411 }
7412
7413 /// A compare and exchange is written by name too, and at the width of the value rather than at
7414 /// the width of the address, which is the mistake worth pinning: everything here is a pointer
7415 /// and only the value says how many bytes the instruction touches.
7416 #[test]
7417 fn a_compare_and_exchange_is_one_instruction_at_the_width_of_the_value() {
7418 for bits in [8, 16, 32, 64] {
7419 let ty = Type::int(bits);
7420 let (mut names, mut source, block, args) = blank(&[Type::PTR, ty, ty]);
7421 let mut build = Builder::new(&mut source, block);
7422 let mem = build.func().add_mem(MemInfo {
7423 size: u64::from(bits / 8),
7424 align: bits / 8,
7425 order: MemOrder::SeqCst,
7426 ..plain()
7427 });
7428 let operands = build.func().push_values(&[args[0], args[1], args[2]]);
7429 build.inst(
7430 InstData {
7431 args: operands,
7432 extra: Extra::Mem(mem),
7433 ..InstData::new(Opcode::Cmpxchg)
7434 },
7435 &[ty, Type::I1],
7436 );
7437
7438 // Two values out of one instruction, the first of them in the register the machine
7439 // reads the expected value out of, the second free for the allocator to place. The
7440 // address is the memory operand and neither of the two values is.
7441 let text = lower(&mut names, &source);
7442 let written = format!("%3:gpr($rax), %4:gpr = x64.cmpxchg_{bits} %1($rax), %2, [%0]");
7443 assert!(text.contains(&written), "{bits}: {text}");
7444 }
7445 }
7446
7447 #[test]
7448 fn more_values_back_than_the_convention_has_registers_for_is_reported() {
7449 let i64 = Type::int(64);
7450 let (mut names, mut source, block, args) = blank(&[i64, i64, i64]);
7451 let mut build = Builder::new(&mut source, block);
7452 build.ret(&[args[0], args[1], args[2]]);
7453
7454 // Two integers come back in `rax` and `rdx` and a third has nowhere to go, which is not a
7455 // gap in the rules but the convention saying no. The front end classifies before it gets
7456 // here, so this is the shape that would mean the classification went wrong.
7457 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7458 .expect_err("only two come back");
7459 assert_eq!(
7460 failed.to_string(),
7461 "what this function gives back takes more registers than this convention has for it"
7462 );
7463
7464 let inst = failed.inst().expect("the instruction it is about");
7465 assert_eq!(source[inst].opcode, Opcode::Return);
7466 }
7467
7468 /// A refusal about a signature has no instruction, which is what makes it the one arm apart.
7469 ///
7470 /// Everything else is about something written somewhere in the body and hands it back so a
7471 /// caller can ask the function where it came from. A parameter arrives before the first
7472 /// instruction runs, so there is nothing in the body to point at and the message is about
7473 /// the function.
7474 #[test]
7475 fn a_refusal_about_a_parameter_has_no_instruction_to_point_at() {
7476 let missing = Unsupported::Argument { index: 0, missing: Missing::OnX87 };
7477 assert_eq!(missing.inst(), None);
7478 }
7479
7480 /// An `alloca` of a fixed size, which is what every local whose address is taken becomes.
7481 fn slot(source: &mut Func, block: Block, size: u64, align: u32) -> Value {
7482 let info = MemInfo { size, align, ..plain() };
7483 let mut build = Builder::new(source, block);
7484 let mem = build.func().add_mem(info);
7485 build.value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR)
7486 }
7487
7488 #[test]
7489 fn a_local_is_memory_in_the_frame_and_one_instruction_that_says_where() {
7490 let (mut names, mut source, block, _) = blank(&[]);
7491 let slot = slot(&mut source, block, 4, 4);
7492 let mut build = Builder::new(&mut source, block);
7493 let nine = build.iconst(Type::int(32), 9);
7494 build.store(nine, slot, plain(), Flags::default());
7495 let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
7496 build.ret(&[loaded]);
7497
7498 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7499 .expect("every instruction has a rule");
7500
7501 // Four bytes on the list the frame is laid out from, and the one instruction that reads
7502 // where they went. Its displacement is nothing here because there is no frame yet, and
7503 // which instruction is waiting for which local is what `finish` is handed.
7504 assert_eq!(lowered.stack.locals, vec![Local { size: 4, align: 4 }]);
7505 assert_eq!(lowered.stack.addresses.len(), 1);
7506 assert_eq!(lowered.stack.addresses[0].1, 0);
7507 assert_eq!(
7508 mir::print_func(&lowered.func, &names, ®S),
7509 "mfunc @f {\nblock0:\n %0:gpr = x64.lea_64 [$rsp]\n \
7510 %1:gpr = x64.mov_ri_32 9\n x64.mov_mr_32 %1, [%0]\n \
7511 %2:gpr = x64.mov_rm_32 [%0]\n x64.ret_val_32 %2($rax)\n}\n"
7512 );
7513 }
7514
7515 #[test]
7516 fn a_local_the_program_declared_says_which_declaration_it_is_and_the_rest_say_nothing() {
7517 let (mut names, mut source, block, _) = blank(&[]);
7518 let scratch = slot(&mut source, block, 4, 4);
7519 let mut build = Builder::new(&mut source, block);
7520 let mem = build.func().add_mem(MemInfo { size: 8, align: 8, ..plain() });
7521 let declared = build
7522 .value(InstData { extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) }, Type::PTR);
7523 build.func().declare_mem(mem, 41);
7524 build.store(scratch, declared, MemInfo { size: 8, align: 8, ..plain() }, Flags::default());
7525 build.ret(&[]);
7526
7527 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7528 .expect("every instruction has a rule");
7529
7530 // Two locals and one declaration, held against the order the allocas were lowered in,
7531 // which is the only name a local has by the time the frame places it. The scratch one was
7532 // reached first and is local zero, so the declared one is local one.
7533 assert_eq!(lowered.stack.locals.len(), 2);
7534 assert_eq!(lowered.stack.declared, vec![(1, 41)]);
7535 }
7536
7537 /// A local the program kept in a value comes out saying which register holds it.
7538 ///
7539 /// The other half of the local above, which had a slot. This one has none, so what carries the
7540 /// declaration is the register the instruction computing it writes into.
7541 #[test]
7542 fn a_local_the_program_kept_in_a_value_says_which_register_holds_it() {
7543 let (mut names, mut source, block, _) = blank(&[]);
7544 let mut build = Builder::new(&mut source, block);
7545 let nine = build.iconst(Type::int(32), 9);
7546 let ten = build.iconst(Type::int(32), 10);
7547 let sum = build.binary(Opcode::Add, nine, ten, Flags::default());
7548 build.func().declare_value(sum, 41);
7549 build.ret(&[sum]);
7550
7551 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7552 .expect("every instruction has a rule");
7553
7554 // One pair and not three. The constants are values the program never declared, and a
7555 // register holding one of those is nobody's. The register is the one the addition writes,
7556 // which the listing under it is what pins down.
7557 assert_eq!(lowered.func.named, vec![(41, mir::Reg::virtual_reg(1))]);
7558 assert_eq!(
7559 mir::print_func(&lowered.func, &names, ®S),
7560 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 9\n \
7561 %1:gpr(reuse 1) = x64.add_ri_32 %0, 10\n x64.ret_val_32 %1($rax)\n}\n"
7562 );
7563 }
7564
7565 /// A local held in a constant two blocks want is two registers and both of them are it.
7566 ///
7567 /// Why the declaration is written down as each register is handed out rather than once at the
7568 /// end over the map from values to registers. That map remembers the last register a value was
7569 /// written into, and a constant is written again in every block that wants one, so a local held
7570 /// in one would come out findable in the last block of the function and nowhere else.
7571 #[test]
7572 fn a_local_held_in_a_constant_two_blocks_want_is_named_in_both_of_them() {
7573 let i32 = Type::int(32);
7574 let (mut names, mut source, entry, args) = blank(&[i32, i32]);
7575 let then = source.create_block();
7576 let other = source.create_block();
7577 let join = source.create_block();
7578 let got = source.append_param(join, i32);
7579
7580 let mut build = Builder::new(&mut source, entry);
7581 let seven = build.iconst(i32, 7);
7582 let cond = build.icmp(rucc_ir::IntPred::Slt, args[0], args[1]);
7583 build.func().declare_value(seven, 41);
7584 build.br_if(cond, then, &[], other, &[]);
7585 Builder::new(&mut source, then).jump(join, &[seven]);
7586 Builder::new(&mut source, other).jump(join, &[seven]);
7587 Builder::new(&mut source, join).ret(&[got]);
7588
7589 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7590 .expect("every instruction has a rule");
7591
7592 let held = &lowered.func.named;
7593 assert_eq!(held.len(), 2, "one register per block that wanted the seven: {held:?}");
7594 assert!(held.iter().all(|&(decl, _)| decl == 41), "{held:?}");
7595 assert_ne!(held[0].1, held[1].1, "the same register in two blocks: {held:?}");
7596 }
7597
7598 /// A parameter the program declared comes out named too, in the register it arrived in.
7599 ///
7600 /// The case the walk over the map at the end is for. A parameter is put in a register the
7601 /// convention chose rather than in a fresh one, so nothing asks the mint for it and the pair
7602 /// would otherwise never be written down.
7603 #[test]
7604 fn a_parameter_the_program_declared_says_which_register_it_arrived_in() {
7605 let i32 = Type::int(32);
7606 let (mut names, mut source, block, args) = blank(&[i32]);
7607 let mut build = Builder::new(&mut source, block);
7608 build.func().declare_value(args[0], 41);
7609 build.ret(&[args[0]]);
7610
7611 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7612 .expect("every instruction has a rule");
7613
7614 let held = &lowered.func.named;
7615 assert_eq!(held.len(), 1, "one pair for the one parameter: {held:?}");
7616 assert_eq!(held[0].0, 41);
7617 }
7618
7619 /// A function with nothing declared in it says nothing, which is every function compiled
7620 /// without debugging information asked for.
7621 #[test]
7622 fn a_function_the_front_end_named_nothing_in_names_no_registers() {
7623 let (mut names, mut source, block, _) = blank(&[]);
7624 let mut build = Builder::new(&mut source, block);
7625 let nine = build.iconst(Type::int(32), 9);
7626 build.ret(&[nine]);
7627
7628 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7629 .expect("every instruction has a rule");
7630 assert!(lowered.func.named.is_empty(), "{:?}", lowered.func.named);
7631 }
7632
7633 #[test]
7634 fn the_frame_is_what_fills_the_address_of_a_local_in() {
7635 let (mut names, mut source, block, _) = blank(&[]);
7636 let slot = slot(&mut source, block, 4, 4);
7637 let mut build = Builder::new(&mut source, block);
7638 let nine = build.iconst(Type::int(32), 9);
7639 build.store(nine, slot, plain(), Flags::default());
7640 let loaded = build.load(Type::int(32), slot, plain(), Flags::default());
7641 build.ret(&[loaded]);
7642
7643 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7644 .expect("every instruction has a rule");
7645 let stack = lowered.stack;
7646 let mut out = lowered.func;
7647 let env = env();
7648 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7649 let layout = stack.layout(Layout::new(&SYSV, REGS));
7650 let frame = Frame::of(&out, &allocation, &layout);
7651 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7652
7653 // `int f(void) { int x; x = 9; return x; }` with the address of `x` taken, end to end.
7654 // A leaf small enough to live in the red zone takes no frame at all, so the stack pointer
7655 // never moves and the four bytes are below it, which is what the negative offset is. The
7656 // instruction the lowering left with nothing in its displacement now has the answer in it.
7657 let text = mir::print_func(&out, &names, ®S);
7658 assert!(text.contains("$rax = x64.lea_64 [$rsp - 8]"), "{text}");
7659 assert!(!text.contains("x64.sub_ri_64"), "{text}");
7660 assert_eq!(frame.size(), 0);
7661 assert_eq!(frame.local(0), Some(-8));
7662 }
7663
7664 /// An `alloca` whose size is an operand, which is a variable length array.
7665 fn growing(source: &mut Func, block: Block, size: Value, align: u32) -> Value {
7666 let info = MemInfo { size: 0, align, ..plain() };
7667 let mut build = Builder::new(source, block);
7668 let mem = build.func().add_mem(info);
7669 let args = build.func().push_values(&[size]);
7670 build.value(
7671 InstData { args, extra: Extra::Mem(mem), ..InstData::new(Opcode::Alloca) },
7672 Type::PTR,
7673 )
7674 }
7675
7676 #[test]
7677 fn a_stack_slot_whose_size_is_not_known_until_it_runs_takes_the_bytes_off_the_stack_pointer() {
7678 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7679 let slot = growing(&mut source, block, args[0], 16);
7680 Builder::new(&mut source, block).ret(&[slot]);
7681
7682 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7683 .expect("every instruction has a rule");
7684
7685 // The bytes come off the stack pointer where the declaration stands and the address is
7686 // where the stack pointer then is, which is one subtraction and one `lea` rather than a
7687 // slot the frame laid out. Nothing is on the list of locals, because there is nothing
7688 // about this the frame could place.
7689 let text = mir::print_func(&lowered.func, &names, ®S);
7690 assert!(text.contains("$rsp = x64.sub_rr_64 $rsp, %0"), "{text}");
7691 assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
7692 assert!(lowered.stack.locals.is_empty(), "{text}");
7693 assert_eq!(lowered.stack.dynamic.len(), 1);
7694 assert!(lowered.stack.grown_at.is_some());
7695 }
7696
7697 #[test]
7698 fn a_growing_slot_wanting_more_alignment_than_the_stack_pointer_has_is_reported() {
7699 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7700 let slot = growing(&mut source, block, args[0], 32);
7701 Builder::new(&mut source, block).ret(&[slot]);
7702
7703 // Thirty two is more than a call leaves the stack pointer on, so giving it what it asked
7704 // for means masking the stack pointer after moving it, and after that no constant reaches
7705 // the rest of the frame from the frame pointer either. A second pointer held for the
7706 // purpose is what fixes it and there is not one yet.
7707 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7708 .expect_err("nothing realigns a frame that grows");
7709 assert_eq!(
7710 failed.to_string(),
7711 "this local wants more alignment than the stack pointer is left on, which needs a \
7712 base register nothing here keeps"
7713 );
7714 }
7715
7716 #[test]
7717 fn a_frame_that_grows_reaches_its_own_locals_through_the_frame_pointer() {
7718 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
7719 let fixed = slot(&mut source, block, 4, 4);
7720 let mut build = Builder::new(&mut source, block);
7721 let nine = build.iconst(Type::int(32), 9);
7722 build.store(nine, fixed, plain(), Flags::default());
7723 let grown = growing(&mut source, block, args[0], 16);
7724 Builder::new(&mut source, block).ret(&[grown]);
7725
7726 let lowered = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7727 .expect("every instruction has a rule");
7728 let stack = lowered.stack;
7729 let mut out = lowered.func;
7730 let env = env();
7731 let allocation = rucc_regalloc::run(&mut out, &env, "test", true);
7732 let layout = stack.layout(Layout::new(&SYSV, REGS));
7733 let frame = Frame::of(&out, &allocation, &layout);
7734 finish(&mut out, &allocation, &frame, &stack, Convention::new(&SYSV, &FRAME), &mut names);
7735
7736 // The stack pointer moves in the middle of the function, so the four bytes of the fixed
7737 // local are not a constant away from it any more and the frame pointer is what reaches
7738 // them. The frame keeps one whatever the flags asked for, takes its bytes rather than
7739 // living in the red zone, and the address of the growing slot is off the stack pointer as
7740 // it stands after the subtraction rather than off anything the prologue left.
7741 let text = mir::print_func(&out, &names, ®S);
7742 assert!(frame.grows());
7743 assert!(frame.frame_pointer());
7744 assert!(frame.size() > 0, "{text}");
7745 assert!(text.contains("x64.lea_64 [$rbp"), "{text}");
7746 assert!(text.contains("$rsp = x64.sub_rr_64 $rsp"), "{text}");
7747 assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
7748 }
7749
7750 #[test]
7751 fn an_address_is_read_written_and_added_to_like_the_integer_it_is() {
7752 let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::int(64)]);
7753 let mut build = Builder::new(&mut source, block);
7754 let stepped = build.func().push_values(&[args[0], args[1]]);
7755 let next =
7756 build.value(InstData { args: stepped, ..InstData::new(Opcode::PtrAdd) }, Type::PTR);
7757 let loaded = build.load(Type::int(32), next, plain(), Flags::default());
7758 build.ret(&[loaded]);
7759
7760 // `int f(int *p, long i) { return *(int *)((char *)p + i); }`. Nothing about this is new
7761 // in the rule set, which is the point: the two addresses arrive in registers because an
7762 // address is an integer as wide as one, and the arithmetic on them is the add it always
7763 // was, so every rule written about an add reaches it.
7764 //
7765 // The add stays its own instruction here rather than folding into the address the load
7766 // reads from. Two registers with no scale on either is the one addressing mode the rules
7767 // have no load through, because the folds that exist are the displacement one and the
7768 // scaled ones, and this is neither. `crate::fold` is what puts the two together, after
7769 // selection, and this is the pair it is handed.
7770 assert_eq!(
7771 lower(&mut names, &source),
7772 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
7773 %1:gpr($rsi) = x64.arg_val_64\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n \
7774 %3:gpr = x64.mov_rm_32 [%2]\n x64.ret_val_32 %3($rax)\n}\n"
7775 );
7776 }
7777
7778 /// The address of a file scope name, which is what every use of a global and every string
7779 /// literal starts from.
7780 fn address_of(source: &mut Func, block: Block, names: &mut Interner, name: &str) -> Value {
7781 let symbol = names.intern(name);
7782 let mut build = Builder::new(source, block);
7783 build.value(
7784 InstData { extra: Extra::Symbol(symbol), ..InstData::new(Opcode::GlobalAddr) },
7785 Type::PTR,
7786 )
7787 }
7788
7789 #[test]
7790 fn the_address_of_a_name_is_one_instruction_carrying_the_name() {
7791 let (mut names, mut source, block, _) = blank(&[]);
7792 let counter = address_of(&mut source, block, &mut names, "counter");
7793 let mut build = Builder::new(&mut source, block);
7794 let loaded = build.load(Type::int(32), counter, plain(), Flags::default());
7795 build.ret(&[loaded]);
7796
7797 // `extern int counter; int f(void) { return counter; }`. The address is an addressing mode
7798 // that names no register and carries the symbol, which is what the assembler writes
7799 // relative to `%rip` and what the object writer leaves a relocation for.
7800 assert_eq!(
7801 lower(&mut names, &source),
7802 "mfunc @f {\nblock0:\n %0:gpr = x64.lea_64 [@counter]\n \
7803 %1:gpr = x64.mov_rm_32 [%0]\n x64.ret_val_32 %1($rax)\n}\n"
7804 );
7805 }
7806
7807 #[test]
7808 fn the_address_of_a_name_outside_the_file_is_read_out_of_the_offset_table() {
7809 let (mut names, mut source, block, _) = blank(&[]);
7810 let away = address_of(&mut source, block, &mut names, "away");
7811 Builder::new(&mut source, block).ret(&[away]);
7812 let elsewhere: Elsewhere = [names.intern("away")].into_iter().collect();
7813
7814 // `extern void away(void); void *f(void) { return away; }`. A load and not an address
7815 // computation, because the distance from here to a name a shared library may be the one
7816 // that defines is not a number any link can work out, and the slot the linker fills in is
7817 // in this program and so is a distance it has.
7818 let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
7819 .expect("every instruction has a rule");
7820 assert_eq!(
7821 mir::print_func(&out.func, &names, ®S),
7822 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [got @away]\n \
7823 x64.ret_val_64 %0($rax)\n}\n"
7824 );
7825 }
7826
7827 #[test]
7828 fn the_address_of_a_thread_local_is_an_offset_out_of_the_table_plus_where_this_thread_starts() {
7829 let (mut names, mut source, block, _) = blank(&[]);
7830 let own = address_of(&mut source, block, &mut names, "own");
7831 Builder::new(&mut source, block).ret(&[own]);
7832 let elsewhere = Elsewhere::default().with_threads([names.intern("own")]);
7833
7834 // `extern _Thread_local int own; void *f(void) { return &own; }`. Three instructions where
7835 // the two cases above are one, because there is no address to load or to work out: the
7836 // slot holds how far into a thread's block the variable sits, `%fs:0` is where this
7837 // thread's block starts, and the sum of the two is this thread's copy.
7838 let out = func(&source, &mut names, &SELECTOR, &SYSV, &elsewhere)
7839 .expect("every instruction has a rule");
7840 assert_eq!(
7841 mir::print_func(&out.func, &names, ®S),
7842 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [thread @own]\n \
7843 %1:gpr = x64.mov_rm_64 [fs:0]\n %2:gpr(reuse 1) = x64.add_rr_64 %0, %1\n \
7844 x64.ret_val_64 %2($rax)\n}\n"
7845 );
7846 }
7847
7848 /// The same load with nothing added to it, which is the whole of `__builtin_thread_pointer`.
7849 #[test]
7850 fn the_start_of_this_thread_s_own_storage_is_the_one_load_and_no_arithmetic() {
7851 let (mut names, mut source, block, _) = blank(&[]);
7852 let here =
7853 Builder::new(&mut source, block).value(InstData::new(Opcode::ThreadPointer), Type::PTR);
7854 Builder::new(&mut source, block).ret(&[here]);
7855
7856 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7857 .expect("every instruction has a rule");
7858 assert_eq!(
7859 mir::print_func(&out.func, &names, ®S),
7860 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [fs:0]\n \
7861 x64.ret_val_64 %0($rax)\n}\n"
7862 );
7863 }
7864
7865 /// One `asm` statement, with its template and its constraint list written as a program does.
7866 fn assembly(
7867 source: &mut Func,
7868 block: Block,
7869 names: &mut Interner,
7870 template: &str,
7871 constraints: &str,
7872 args: &[Value],
7873 results: &[Type],
7874 ) -> Inst {
7875 clobbering(source, block, names, template, constraints, "memory", args, results)
7876 }
7877
7878 /// The same with a clobber list of its own, for the statements that are about one.
7879 #[allow(clippy::too_many_arguments)]
7880 fn clobbering(
7881 source: &mut Func,
7882 block: Block,
7883 names: &mut Interner,
7884 template: &str,
7885 constraints: &str,
7886 clobbers: &str,
7887 args: &[Value],
7888 results: &[Type],
7889 ) -> Inst {
7890 let info = AsmInfo {
7891 template: names.intern(template),
7892 constraints: names.intern(constraints),
7893 clobbers: names.intern(clobbers),
7894 targets: rucc_ir::BlockCallList::EMPTY,
7895 };
7896 Builder::new(source, block).inline_asm(info, args, results, Flags::VOLATILE)
7897 }
7898
7899 /// What a program asking the processor what it can do writes, which is the instruction whose
7900 /// every operand is a register its text does not name.
7901 #[test]
7902 fn a_template_whose_registers_are_named_by_the_constraints_places_them_from_the_letters() {
7903 let u32 = Type::int(32);
7904 let (mut names, mut source, block, _) = blank(&[]);
7905 let zero = Builder::new(&mut source, block).iconst(u32, 0);
7906 let out = clobbering(
7907 &mut source,
7908 block,
7909 &mut names,
7910 "cpuid",
7911 "=a,a",
7912 "ebx,ecx,edx",
7913 &[zero],
7914 &[u32],
7915 );
7916 let produced = source[out].results().next().expect("one result");
7917 Builder::new(&mut source, block).ret(&[produced]);
7918
7919 // `asm ("cpuid" : "=a" (n) : "a" (0) : "ebx", "ecx", "edx")`, which is the first thing
7920 // every program that has a faster path on some machines writes. Four registers written and
7921 // two read, none of them in the template, all of them out of the description, and the two
7922 // that the letters named are the statement's own. The subleaf is a zero because the
7923 // instruction reads `ecx` and the program said nothing about what is in it. The three
7924 // clobbers are gone because `cpuid` writes those three anyway, and saying it twice is one
7925 // register with two definitions.
7926 assert_eq!(
7927 lower(&mut names, &source),
7928 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n \
7929 %1:gpr = x64.mov_ri_64 0\n \
7930 %2:gpr($rax), %3:gpr($rbx), %4:gpr($rcx), %5:gpr($rdx) = x64.cpuid %0($rax), \
7931 %1($rcx)\n x64.ret_val_32 %2($rax)\n}\n"
7932 );
7933 }
7934
7935 /// An operand the program pinned, by declaring the object it comes from `register long x asm
7936 /// ("r12")`. The letter on its own leaves the allocator to pick, and a template that reads the
7937 /// register by name needs the two to be the same register, so the brace is what ties them
7938 /// together. That is the one use of a local register variable the GNU manual calls reliable,
7939 /// and it is what tcc's `tests/tcctest.c` counts on.
7940 #[test]
7941 fn an_operand_the_program_pinned_is_placed_in_the_register_it_named() {
7942 let u64 = Type::int(64);
7943 let (mut names, mut source, block, _) = blank(&[]);
7944 let out =
7945 assembly(&mut source, block, &mut names, "mov $0x4542, %r12", "=r{r12}", &[], &[u64]);
7946 let produced = source[out].results().next().expect("one result");
7947 Builder::new(&mut source, block).ret(&[produced]);
7948
7949 // The template is one instruction the table already has, so it lowers to that instruction
7950 // rather than to text nobody read, and the register it names is the statement's own output
7951 // because the brace put the output there. Without the brace the letter would have let the
7952 // allocator pick, the two `%r12` would have been different registers, and the program would
7953 // have come back with whatever was in the one it picked.
7954 assert_eq!(
7955 lower(&mut names, &source),
7956 "mfunc @f {\nblock0:\n %0:gpr($r12) = x64.mov_ri_64 17730\n \
7957 x64.ret_val_64 %0($rax)\n}\n"
7958 );
7959 }
7960
7961 /// A clobber the instruction does not write itself, which is the case the list is there for.
7962 /// It goes on as a definition of the register, in among the other definitions, because that is
7963 /// the whole of how a machine function says a register is not worth anything after this.
7964 #[test]
7965 fn a_clobber_the_instruction_does_not_write_itself_is_a_definition_of_that_register() {
7966 let (mut names, mut source, block, _) = blank(&[]);
7967 clobbering(&mut source, block, &mut names, "pause", "", "rsi,cc,memory", &[], &[]);
7968 Builder::new(&mut source, block).ret(&[]);
7969
7970 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n $rsi = x64.pause\n}\n");
7971 }
7972
7973 /// A clobber naming something this has no register for. Refused rather than dropped, since the
7974 /// list is the program saying which registers it may not leave anything in, and an entry
7975 /// nobody read is a register something may still be left in.
7976 #[test]
7977 fn a_clobber_this_has_no_register_for_is_refused() {
7978 let (mut names, mut source, block, _) = blank(&[]);
7979 clobbering(&mut source, block, &mut names, "pause", "", "zmm0", &[], &[]);
7980 Builder::new(&mut source, block).ret(&[]);
7981
7982 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
7983 .expect_err("there is no such register here");
7984 assert_eq!(
7985 failed.to_string(),
7986 "this `asm` says it destroys a register this has no name for"
7987 );
7988 }
7989
7990 #[test]
7991 fn an_asm_with_an_empty_template_and_no_operands_is_no_instructions() {
7992 let (mut names, mut source, block, _) = blank(&[]);
7993 assembly(&mut source, block, &mut names, "", "", &[], &[]);
7994 Builder::new(&mut source, block).ret(&[]);
7995
7996 // `asm volatile ("" : : : "memory")`, which is a barrier and nothing else. The barrier was
7997 // spent on the optimizer, which has finished by now, so what is left is nothing.
7998 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n}\n");
7999 }
8000
8001 #[test]
8002 fn an_output_an_input_is_tied_to_is_the_register_that_input_arrived_in() {
8003 let i32 = Type::int(32);
8004 let (mut names, mut source, block, args) = blank(&[i32]);
8005 let out = assembly(&mut source, block, &mut names, "", "=r,0", &args, &[i32]);
8006 let produced = source[out].results().next().expect("one result");
8007 Builder::new(&mut source, block).ret(&[produced]);
8008
8009 // `asm ("" : "=r" (x) : "0" (x))`, which is how a program stops the optimizer following a
8010 // value without changing it. The two share a place and the template writes nothing over
8011 // it, so the value comes back out of the register it went in.
8012 assert_eq!(
8013 lower(&mut names, &source),
8014 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
8015 x64.ret_val_32 %0($rax)\n}\n"
8016 );
8017 }
8018
8019 #[test]
8020 fn an_output_written_plus_is_the_same_rename() {
8021 let i32 = Type::int(32);
8022 let (mut names, mut source, block, args) = blank(&[i32]);
8023 let out = assembly(&mut source, block, &mut names, "", "+r", &args, &[i32]);
8024 let produced = source[out].results().next().expect("one result");
8025 Builder::new(&mut source, block).ret(&[produced]);
8026
8027 // `asm ("" : "+r" (x))`, which says the same thing in one operand instead of two.
8028 assert_eq!(
8029 lower(&mut names, &source),
8030 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
8031 x64.ret_val_32 %0($rax)\n}\n"
8032 );
8033 }
8034
8035 #[test]
8036 fn an_output_nothing_is_tied_to_is_a_zero() {
8037 let i32 = Type::int(32);
8038 let (mut names, mut source, block, _) = blank(&[]);
8039 let out = assembly(&mut source, block, &mut names, "", "=r", &[], &[i32]);
8040 let produced = source[out].results().next().expect("one result");
8041 Builder::new(&mut source, block).ret(&[produced]);
8042
8043 // `asm ("" : "=r" (y))`, whose answer is whatever the assembly left in the register, and
8044 // an empty template leaves nothing. A definite value rather than a register nothing wrote,
8045 // because the allocator is owed a definition before the use however little the program is.
8046 assert_eq!(
8047 lower(&mut names, &source),
8048 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_32 0\n x64.ret_val_32 %0($rax)\n}\n"
8049 );
8050 }
8051
8052 #[test]
8053 fn a_template_that_is_one_instruction_becomes_that_instruction() {
8054 let (mut names, mut source, block, _) = blank(&[]);
8055 assembly(&mut source, block, &mut names, "pause", "", &[], &[]);
8056 Builder::new(&mut source, block).ret(&[]);
8057
8058 // `asm volatile ("pause")`, which is what every spin lock in every allocator writes. One
8059 // instruction, no operands, and nothing between the template and the machine but the table
8060 // that already says what a `pause` is.
8061 assert_eq!(lower(&mut names, &source), "mfunc @f {\nblock0:\n x64.pause\n}\n");
8062 }
8063
8064 #[test]
8065 fn a_template_that_reads_a_segment_becomes_the_load_it_already_was() {
8066 let i64 = Type::int(64);
8067 let (mut names, mut source, block, _) = blank(&[]);
8068 let out = assembly(&mut source, block, &mut names, "movq %%fs:0, %0", "=r", &[], &[i64]);
8069 let produced = source[out].results().next().expect("one result");
8070 Builder::new(&mut source, block).ret(&[produced]);
8071
8072 // `asm ("movq %%fs:0, %0" : "=r" (tid))`, which is how a program finds the block its own
8073 // thread owns. The same instruction `crate::lower` already writes for a thread-local
8074 // variable, reached this time because a program wrote it out by hand.
8075 assert_eq!(
8076 lower(&mut names, &source),
8077 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rm_64 [fs:0]\n \
8078 x64.ret_val_64 %0($rax)\n}\n"
8079 );
8080 }
8081
8082 /// A template this cannot read is kept as its text, which is what gcc does with every template.
8083 /// Whether the text is an instruction is the assembler's question, asked when the unit is
8084 /// assembled from its listing.
8085 #[test]
8086 fn a_template_naming_an_instruction_this_machine_has_not_got_is_kept_as_text() {
8087 let (mut names, mut source, block, _) = blank(&[]);
8088 assembly(&mut source, block, &mut names, "hcf", "", &[], &[]);
8089 Builder::new(&mut source, block).ret(&[]);
8090
8091 let printed = lower(&mut names, &source);
8092 assert!(printed.contains("x64.template"), "{printed}");
8093 assert!(printed.contains("@hcf"), "{printed}");
8094 }
8095
8096 /// A template kept as text with an operand in a register reads the operand, and its text holds
8097 /// a hole naming that operand of the instruction, which the writer fills with the register the
8098 /// allocator chose. The input is the instruction's only use, behind every register a call may
8099 /// write.
8100 #[test]
8101 fn a_template_kept_as_text_reads_an_operand_in_a_register_through_a_hole() {
8102 let i32 = Type::int(32);
8103 let (mut names, mut source, block, args) = blank(&[i32]);
8104 assembly(&mut source, block, &mut names, "hcf %0", "r", &[args[0]], &[]);
8105 Builder::new(&mut source, block).ret(&[]);
8106
8107 let printed = lower(&mut names, &source);
8108 let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8109 // Twenty five registers are written ahead of it, so the operand read is the twenty sixth,
8110 // spelled at the width of an `int`.
8111 assert!(line.contains("x64.template %0, @hcf \u{1}r25k\u{2}"), "{printed}");
8112 assert!(line.contains("early $rax"), "{printed}");
8113 }
8114
8115 /// A template kept as text with more outputs than the convention keeps registers across a call
8116 /// gets back as many of the registers a call may write as it needs, from the end of the order,
8117 /// and keeps the rest. Six outputs against five preserved registers is one handed back, which is
8118 /// `r11`. The shape is `sodium_sub` in libsodium, whose `sbbq` into memory the reader has no
8119 /// form for, and before this the allocator ran out of registers on it.
8120 #[test]
8121 fn a_template_kept_as_text_with_more_outputs_than_are_kept_gets_registers_back() {
8122 let i64 = Type::int(64);
8123 let (mut names, mut source, block, _) = blank(&[]);
8124 let outputs = [i64; 6];
8125 let asm = assembly(
8126 &mut source,
8127 block,
8128 &mut names,
8129 "hcf %0, %1, %2, %3, %4, %5",
8130 "=&r,=&r,=&r,=&r,=&r,=&r",
8131 &[],
8132 &outputs,
8133 );
8134 let produced: Vec<Value> = source[asm].results().collect();
8135 Builder::new(&mut source, block).ret(&produced[..1]);
8136
8137 let printed = lower(&mut names, &source);
8138 let line = printed.lines().find(|line| line.contains("x64.template")).unwrap_or_default();
8139 assert!(line.contains("early $r10"), "{printed}");
8140 assert!(!line.contains("early $r11"), "{printed}");
8141 }
8142
8143 /// A register the template named is placed as itself, fixed to the register the program wrote
8144 /// down. A register a constraint letter names is a different thing and is placed too, which the
8145 /// test above is about: there the statement said which of its own operands is in the register,
8146 /// and a name in the middle of a template says the register and nothing about any operand.
8147 #[test]
8148 fn a_template_naming_a_register_gets_that_register() {
8149 let i64 = Type::int(64);
8150 let (mut names, mut source, block, _) = blank(&[]);
8151 let out = assembly(&mut source, block, &mut names, "movq %%rax, %0", "=r", &[], &[i64]);
8152 let produced = source[out].results().next().expect("one result");
8153 Builder::new(&mut source, block).ret(&[produced]);
8154
8155 // `asm ("movq %%rax, %0" : "=r" (x))`, which is a program reading whatever is in `%rax`.
8156 // The source is the register itself and the destination is one the allocator picks.
8157 assert_eq!(
8158 lower(&mut names, &source),
8159 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rr_64 $rax($rax)\n \
8160 x64.ret_val_64 %0($rax)\n}\n"
8161 );
8162 }
8163
8164 /// The half of the same thing every register saving template needs. micropython writes the
8165 /// callee-saved registers into a buffer one `movq %%r12, 48(%%rdi)` at a time, and both halves
8166 /// of that line are a register the template named: the one being stored and the one the address
8167 /// is counted from.
8168 #[test]
8169 fn a_template_counting_an_address_from_a_register_it_named_gets_that_register() {
8170 let (mut names, mut source, block, _) = blank(&[]);
8171 assembly(&mut source, block, &mut names, "movq %%r12, 48(%%rdi)", "", &[], &[]);
8172 Builder::new(&mut source, block).ret(&[]);
8173
8174 assert_eq!(
8175 lower(&mut names, &source),
8176 "mfunc @f {\nblock0:\n x64.mov_mr_64 $r12($r12), [$rdi + 48]\n}\n"
8177 );
8178 }
8179
8180 /// A local kept in a named register, which is the same register named as itself and reached
8181 /// from the other side. micropython's collector writes six of these and reads them with
8182 /// ordinary C rather than with a template.
8183 #[test]
8184 fn a_local_kept_in_a_named_register_is_one_move_out_of_it() {
8185 let (mut names, mut source, block, _) = blank(&[]);
8186 let held = names.intern("rbx");
8187 let value = Builder::new(&mut source, block).value(
8188 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8189 Type::int(64),
8190 );
8191 Builder::new(&mut source, block).ret(&[value]);
8192
8193 assert_eq!(
8194 lower(&mut names, &source),
8195 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_rr_64 $rbx($rbx)\n \
8196 x64.ret_val_64 %0($rax)\n}\n"
8197 );
8198 }
8199
8200 /// The sigil gcc allows in front of the name is syntax and comes off, and a name that is not
8201 /// a register of this machine is refused in words that say which name it was.
8202 #[test]
8203 fn a_register_name_is_read_with_or_without_its_sigil_and_refused_when_there_is_no_such_one() {
8204 for written in ["%r12", "r12"] {
8205 let (mut names, mut source, block, _) = blank(&[]);
8206 let held = names.intern(written);
8207 let value = Builder::new(&mut source, block).value(
8208 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8209 Type::int(64),
8210 );
8211 Builder::new(&mut source, block).ret(&[value]);
8212 assert!(lower(&mut names, &source).contains("$r12($r12)"), "{written} is not read");
8213 }
8214
8215 let (mut names, mut source, block, _) = blank(&[]);
8216 let held = names.intern("nowhere");
8217 let value = Builder::new(&mut source, block).value(
8218 InstData { extra: Extra::Symbol(held), ..InstData::new(Opcode::RegisterValue) },
8219 Type::int(64),
8220 );
8221 Builder::new(&mut source, block).ret(&[value]);
8222
8223 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8224 .expect_err("there is no such register");
8225 assert_eq!(
8226 failed.to_string(),
8227 "this object is kept in `nowhere`, which is not a register this machine has"
8228 );
8229 }
8230
8231 #[test]
8232 fn a_constraint_list_that_does_not_describe_the_operands_is_refused() {
8233 let i32 = Type::int(32);
8234 let (mut names, mut source, block, args) = blank(&[i32]);
8235 assembly(&mut source, block, &mut names, "", "=r", &args, &[]);
8236 Builder::new(&mut source, block).ret(&[]);
8237
8238 // An output with no result to be, which is what the front end never writes and what a
8239 // hand written module can. Refused rather than placed by a guess.
8240 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8241 .expect_err("the list and the instruction disagree");
8242 assert_eq!(failed.to_string(), "this `asm` has an operand this cannot place");
8243 }
8244
8245 /// A cast between a pointer and an integer, at whatever width the result is asked for.
8246 fn cast(source: &mut Func, block: Block, opcode: Opcode, from: Value, to: Type) -> Value {
8247 let mut build = Builder::new(source, block);
8248 let args = build.func().push_values(&[from]);
8249 build.value(InstData { args, ..InstData::new(opcode) }, to)
8250 }
8251
8252 #[test]
8253 fn a_cast_between_a_pointer_and_an_integer_as_wide_is_no_instruction_at_all() {
8254 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8255 let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(64));
8256 Builder::new(&mut source, block).ret(&[number]);
8257
8258 // `long f(void *p) { return (long)p; }`. An address on this machine is an integer as wide
8259 // as the machine addresses, so the cast changes what the type system calls the value and
8260 // changes nothing about the value, and the register holding it is the one that held it.
8261 assert_eq!(
8262 lower(&mut names, &source),
8263 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n \
8264 x64.ret_val_64 %0($rax)\n}\n"
8265 );
8266 }
8267
8268 #[test]
8269 fn a_null_pointer_is_a_constant_that_reaches_a_register_before_anything_reads_it() {
8270 let (mut names, mut source, block, _) = blank(&[]);
8271 let mut build = Builder::new(&mut source, block);
8272 let zero = build.iconst(Type::int(64), 0);
8273 let null = cast(&mut source, block, Opcode::IntToPtr, zero, Type::PTR);
8274 Builder::new(&mut source, block).ret(&[null]);
8275
8276 // `void *f(void) { return 0; }`. The cast is nothing, and reading its operand is what
8277 // writes the zero down: a constant is materialized where it is wanted rather than where
8278 // the IR defined it, and without the read there would be no instruction at all.
8279 assert_eq!(
8280 lower(&mut names, &source),
8281 "mfunc @f {\nblock0:\n %0:gpr = x64.mov_ri_64 0\n x64.ret_val_64 %0($rax)\n}\n"
8282 );
8283 }
8284
8285 #[test]
8286 fn the_five_linkages_the_ir_has_narrow_to_the_three_an_object_file_can_say() {
8287 let readings = [
8288 (Linkage::External, mir::Binding::Global),
8289 (Linkage::Common, mir::Binding::Global),
8290 (Linkage::Internal, mir::Binding::Local),
8291 (Linkage::Weak, mir::Binding::Weak),
8292 (Linkage::LinkOnce, mir::Binding::Weak),
8293 ];
8294 for (linkage, wanted) in readings {
8295 let (mut names, mut source, block, _) = blank(&[]);
8296 source.linkage = linkage;
8297 Builder::new(&mut source, block).ret(&[]);
8298 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8299 .expect("a return");
8300 // The narrowing is done here rather than where the object is written, because a
8301 // machine function is all the assembler and the writer are ever handed.
8302 assert_eq!(out.func.binding, wanted, "{linkage:?}");
8303 }
8304 }
8305
8306 /// The visibility makes the same trip and is not narrowed on the way, because ELF says all
8307 /// three of them.
8308 ///
8309 /// Here for the reason the linkage above is here. A machine function is the whole of what the
8310 /// assembler and the object writer are handed, so a fact about the symbol that does not get
8311 /// onto one is a fact that is gone by the time anything could write it down, and the way that
8312 /// shows up is a shared library exporting the wrong set of names with nothing said anywhere.
8313 #[test]
8314 fn the_visibility_survives_the_trip_from_the_ir_to_a_machine_function() {
8315 let readings = [
8316 (Visibility::Default, mir::Visibility::Default),
8317 (Visibility::Hidden, mir::Visibility::Hidden),
8318 (Visibility::Protected, mir::Visibility::Protected),
8319 ];
8320 for (visibility, wanted) in readings {
8321 let (mut names, mut source, block, _) = blank(&[]);
8322 source.visibility = visibility;
8323 Builder::new(&mut source, block).ret(&[]);
8324 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8325 .expect("a return");
8326 assert_eq!(out.func.visibility, wanted, "{visibility:?}");
8327 }
8328 }
8329
8330 #[test]
8331 fn a_cast_between_a_pointer_and_a_narrower_integer_is_reported() {
8332 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8333 let number = cast(&mut source, block, Opcode::PtrToInt, args[0], Type::int(32));
8334 Builder::new(&mut source, block).ret(&[number]);
8335
8336 // The front end never writes one: it casts at the address width and truncates or extends
8337 // around it, so both of those are the rules they always were. IR from somewhere else that
8338 // does write one is refused rather than compiled to a move that keeps the high half.
8339 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8340 .expect_err("no rule narrows an address");
8341 assert_eq!(failed.to_string(), "no rule lowers a `ptrtoint` producing a `i32`");
8342 }
8343
8344 /// The type this machine has no register for.
8345 fn long_double() -> Type {
8346 Type::float(rucc_ir::Float::F80)
8347 }
8348
8349 #[test]
8350 fn a_double_widened_and_narrowed_again_goes_out_through_the_frame_and_back() {
8351 let f64 = Type::float(rucc_ir::Float::F64);
8352 let (mut names, mut source, block, args) = blank(&[f64]);
8353 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8354 let back = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8355 Builder::new(&mut source, block).ret(&[back]);
8356
8357 // `double f(double d) { long double x = d; return x; }`. The x87 reads memory and nothing
8358 // else, so the value is written to the crossing slot, loaded at the format that widens it
8359 // and put in the slot the eighty bit value lives in. Coming back is the same three the
8360 // other way. Both slots are addressed by a `lea` with nothing in it yet, which is what
8361 // every address in a frame looks like here until `finish` has the numbers.
8362 assert_eq!(
8363 lower(&mut names, &source),
8364 "mfunc @f {\nblock0:\n \
8365 %0:xmm($xmm0) = x64.arg_val_f64\n \
8366 %1:gpr = x64.lea_64 [$rsp]\n \
8367 %2:gpr = x64.lea_64 [$rsp]\n \
8368 x64.movsd_mr %0, [%1]\n \
8369 x64.fld_l [%1]\n \
8370 x64.fstp_t [%2]\n \
8371 %3:gpr = x64.lea_64 [$rsp]\n \
8372 %4:gpr = x64.lea_64 [$rsp]\n \
8373 x64.fld_t [%3]\n \
8374 x64.fstp_l [%4]\n \
8375 %5:xmm = x64.movsd_rm [%4]\n \
8376 x64.ret_val_f64 %5($xmm0)\n}\n"
8377 );
8378 }
8379
8380 #[test]
8381 fn a_long_double_has_sixteen_bytes_of_its_own_and_keeps_them() {
8382 let f64 = Type::float(rucc_ir::Float::F64);
8383 let (mut names, mut source, block, args) = blank(&[f64]);
8384 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8385 let once = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8386 let twice = cast(&mut source, block, Opcode::FPTrunc, wide, f64);
8387 let mut build = Builder::new(&mut source, block);
8388 let sum = build.binary(Opcode::FAdd, once, twice, Flags::default());
8389 build.ret(&[sum]);
8390
8391 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8392 .expect("every instruction is written");
8393
8394 // Two slots and not four: sixteen bytes for the one eighty bit value, which is what the
8395 // psABI says one takes and is aligned to, and eight for the crossing, which every group
8396 // in the function shares because nothing is ever left in it. The value's slot is its own
8397 // for the whole function, so reading it twice reads the same sixteen bytes.
8398 assert_eq!(
8399 out.stack.locals,
8400 vec![Local { size: 8, align: 8 }, Local { size: 16, align: 16 }]
8401 );
8402 }
8403
8404 #[test]
8405 fn an_integer_becomes_a_long_double_by_being_loaded_as_one() {
8406 let (mut names, mut source, block, args) = blank(&[Type::int(64)]);
8407 let wide = cast(&mut source, block, Opcode::SIToFP, args[0], long_double());
8408 let back =
8409 cast(&mut source, block, Opcode::FPTrunc, wide, Type::float(rucc_ir::Float::F64));
8410 Builder::new(&mut source, block).ret(&[back]);
8411
8412 // `double f(long n) { long double x = n; return x; }`. `fild` is the same push at another
8413 // format, so the conversion is the load and there is no instruction that converts.
8414 let text = lower(&mut names, &source);
8415 assert!(text.contains("x64.mov_mr_64 %0, [%1]"), "{text}");
8416 assert!(text.contains("x64.fild_ll [%1]"), "{text}");
8417 }
8418
8419 #[test]
8420 fn a_long_double_becoming_an_integer_cuts_towards_zero_with_the_control_word() {
8421 let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
8422 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8423 let whole = cast(&mut source, block, Opcode::FPToSI, wide, Type::int(32));
8424 Builder::new(&mut source, block).ret(&[whole]);
8425
8426 // The one conversion here with no single instruction behind it. C cuts towards zero and
8427 // the unit rounds the way its control word says, so the word is saved, ORed with the two
8428 // bits that mean truncate, loaded, used and put back. Nine instructions for what `fisttp`
8429 // does in one, and `spec/10-backend.md` section 10.8 says why that one is not used.
8430 let text = lower(&mut names, &source);
8431 let group: Vec<&str> = text
8432 .lines()
8433 .map(str::trim)
8434 .filter(|line| line.starts_with("x64.f") || line.contains("_16"))
8435 .collect();
8436 assert_eq!(
8437 group,
8438 [
8439 "x64.fld_l [%1]",
8440 "x64.fstp_t [%2]",
8441 "x64.fnstcw [%5]",
8442 "%6:gpr = x64.mov_rm_16 [%5]",
8443 "%7:gpr(reuse 1) = x64.or_ri_16 %6, 3072",
8444 "x64.mov_mr_16 %7, [%5 + 2]",
8445 "x64.fldcw [%5 + 2]",
8446 "x64.fld_t [%3]",
8447 "x64.fistp_l [%4]",
8448 "x64.fldcw [%5]",
8449 ],
8450 "{text}"
8451 );
8452 }
8453
8454 #[test]
8455 fn a_long_double_is_read_and_written_as_the_bits_it_already_is() {
8456 let (mut names, mut source, block, args) = blank(&[Type::PTR, Type::PTR]);
8457 let mut build = Builder::new(&mut source, block);
8458 let value = build.load(long_double(), args[0], plain(), Flags::default());
8459 build.store(value, args[1], plain(), Flags::default());
8460 build.ret(&[]);
8461
8462 // `void f(long double *a, long double *b) { *b = *a; }`. A copy is a push and a pop at the
8463 // format the value is already in, which neither converts nor looks: a signalling NaN stays
8464 // one and nothing is raised, which is the whole of what makes it a copy.
8465 let text = lower(&mut names, &source);
8466 let group: Vec<&str> =
8467 text.lines().map(str::trim).filter(|line| line.starts_with("x64.f")).collect();
8468 assert_eq!(
8469 group,
8470 ["x64.fld_t [%0]", "x64.fstp_t [%2]", "x64.fld_t [%3]", "x64.fstp_t [%1]"],
8471 "{text}"
8472 );
8473 }
8474
8475 /// Two `long double` values, from two `double` parameters, and the instructions that made
8476 /// them, which every test below this one throws away.
8477 fn two_long_doubles(source: &mut Func, block: Block, args: &[Value]) -> (Value, Value) {
8478 let left = cast(source, block, Opcode::FPExt, args[0], long_double());
8479 let right = cast(source, block, Opcode::FPExt, args[1], long_double());
8480 (left, right)
8481 }
8482
8483 /// The x87 instructions of a function, in order, with everything else dropped.
8484 fn stack_only(text: &str) -> Vec<&str> {
8485 text.lines().map(str::trim).filter(|line| line.contains("x64.f")).collect()
8486 }
8487
8488 /// The two frame slots the last two addresses of a function were taken of, which in a
8489 /// comparison are the two operands in the order they go on the stack.
8490 fn pushed(out: &Lowered) -> Vec<usize> {
8491 let taken: Vec<usize> = out.stack.addresses.iter().map(|&(_, local)| local).collect();
8492 taken[taken.len() - 2..].to_vec()
8493 }
8494
8495 #[test]
8496 fn adding_two_long_doubles_pushes_both_and_leaves_the_answer_in_a_slot() {
8497 let f64 = Type::float(rucc_ir::Float::F64);
8498 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8499 let (left, right) = two_long_doubles(&mut source, block, &args);
8500 let sum =
8501 Builder::new(&mut source, block).binary(Opcode::FAdd, left, right, Flags::default());
8502 let back = cast(&mut source, block, Opcode::FPTrunc, sum, f64);
8503 Builder::new(&mut source, block).ret(&[back]);
8504
8505 // `double f(double a, double b) { return (long double) a + (long double) b; }`. The last
8506 // four lines are the add: both operands pushed, the instruction that names neither of
8507 // them because they are the top two of a stack, and the answer taken off into its slot.
8508 let text = lower(&mut names, &source);
8509 assert_eq!(
8510 stack_only(&text),
8511 [
8512 "x64.fld_l [%2]",
8513 "x64.fstp_t [%3]",
8514 "x64.fld_l [%4]",
8515 "x64.fstp_t [%5]",
8516 "x64.fld_t [%6]",
8517 "x64.fld_t [%7]",
8518 "x64.fadd_p",
8519 "x64.fstp_t [%8]",
8520 "x64.fld_t [%9]",
8521 "x64.fstp_l [%10]",
8522 ],
8523 "{text}"
8524 );
8525 }
8526
8527 #[test]
8528 fn a_subtraction_pushes_the_left_operand_first_and_asks_for_the_att_spelling() {
8529 let f64 = Type::float(rucc_ir::Float::F64);
8530 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8531 let (left, right) = two_long_doubles(&mut source, block, &args);
8532 let less =
8533 Builder::new(&mut source, block).binary(Opcode::FSub, left, right, Flags::default());
8534 let back = cast(&mut source, block, Opcode::FPTrunc, less, f64);
8535 Builder::new(&mut source, block).ret(&[back]);
8536
8537 // The left one goes on first, so it ends up under the right one, and the answer wanted is
8538 // the one below minus the top. In AT&T that is `fsubrp`, since `fsubp` there is `DE E0+i`
8539 // and computes the other one. The `r` says which spelling this is and not which order the
8540 // pushes were in. `crates/rucc/tests/x87.rs` is what says the answer is right, because a
8541 // name is what got this wrong the first time.
8542 let text = lower(&mut names, &source);
8543 assert_eq!(
8544 &stack_only(&text)[4..8],
8545 ["x64.fld_t [%6]", "x64.fld_t [%7]", "x64.fsubr_p", "x64.fstp_t [%8]"],
8546 "{text}"
8547 );
8548 }
8549
8550 #[test]
8551 fn negating_a_long_double_turns_the_sign_over_and_reads_nothing() {
8552 let f64 = Type::float(rucc_ir::Float::F64);
8553 let (mut names, mut source, block, args) = blank(&[f64]);
8554 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8555 let flipped = Builder::new(&mut source, block).unary(Opcode::FNeg, wide, long_double());
8556 let back = cast(&mut source, block, Opcode::FPTrunc, flipped, f64);
8557 Builder::new(&mut source, block).ret(&[back]);
8558
8559 // `fchs` and not a subtraction from zero, which would give a different answer at a negative
8560 // zero and would signal at a NaN. It does not read the value as a number at all.
8561 let text = lower(&mut names, &source);
8562 assert_eq!(
8563 &stack_only(&text)[2..5],
8564 ["x64.fld_t [%3]", "x64.fchs", "x64.fstp_t [%4]"],
8565 "{text}"
8566 );
8567 }
8568
8569 #[test]
8570 fn comparing_two_long_doubles_puts_the_left_one_on_top() {
8571 let f64 = Type::float(rucc_ir::Float::F64);
8572 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8573 let (left, right) = two_long_doubles(&mut source, block, &args);
8574 let mut build = Builder::new(&mut source, block);
8575 build.fcmp(FloatPred::Ogt, left, right, Flags::default());
8576 build.ret(&[]);
8577
8578 // `a > b`. `fucomip` asks about the top of the stack against what is under it, so the
8579 // operand the predicate is about has to go on last, which is the other way round from the
8580 // arithmetic above. The pop that clears the loser and the byte that reads the flags are
8581 // both inside the one opcode.
8582 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8583 .expect("every instruction is written");
8584 let slots = pushed(&out);
8585 assert_eq!(slots, [2, 1], "the right operand goes on first and the left one on top");
8586 let text = mir::print_func(&out.func, &names, ®S);
8587 assert_eq!(
8588 &stack_only(&text)[4..],
8589 ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
8590 "{text}"
8591 );
8592 }
8593
8594 #[test]
8595 fn a_comparison_that_the_machine_has_backwards_swaps_the_two_pushes() {
8596 let f64 = Type::float(rucc_ir::Float::F64);
8597 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8598 let (left, right) = two_long_doubles(&mut source, block, &args);
8599 let mut build = Builder::new(&mut source, block);
8600 build.fcmp(FloatPred::Olt, left, right, Flags::default());
8601 build.ret(&[]);
8602
8603 // `a < b` is `b > a` and this machine has the one condition, so the same opcode runs with
8604 // the operands the other way round. The same trade the vector rules make, and it has to
8605 // be the same one: a `long double` comparison that picked a different condition from the
8606 // `double` comparison of the same two numbers would be wrong at exactly the unordered
8607 // cases the two conditions differ on.
8608 //
8609 // Which slot each push names is the whole of the difference from the test above, and the
8610 // text does not show it, since an address in a frame is a `lea` with nothing in it until
8611 // `finish` has the numbers. So the slots are what is read here.
8612 let out = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8613 .expect("every instruction is written");
8614 let slots = pushed(&out);
8615 assert_eq!(slots, [1, 2], "the left operand goes on first and the right one on top");
8616 let text = mir::print_func(&out.func, &names, ®S);
8617 assert_eq!(
8618 &stack_only(&text)[4..],
8619 ["x64.fld_t [%6]", "x64.fld_t [%7]", "%8:gpr = x64.fucomip_set_a"],
8620 "{text}"
8621 );
8622 }
8623
8624 #[test]
8625 fn an_ordered_equal_needs_a_second_byte_to_put_the_two_conditions_together() {
8626 let f64 = Type::float(rucc_ir::Float::F64);
8627 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8628 let (left, right) = two_long_doubles(&mut source, block, &args);
8629 let mut build = Builder::new(&mut source, block);
8630 build.fcmp(FloatPred::Oeq, left, right, Flags::default());
8631 build.ret(&[]);
8632
8633 // Equal and ordered are two conditions and the flags carry both, so the opcode writes a
8634 // second register as well as the one the value is in and ANDs them together. Said here by
8635 // handing it a spare, since an instruction that wrote a register nothing knew about would
8636 // be an instruction the allocator could put a live value in the way of.
8637 let text = lower(&mut names, &source);
8638 assert!(text.contains("%8:gpr, %9:gpr = x64.fucomip_set_e_and_np"), "{text}");
8639 }
8640
8641 #[test]
8642 fn a_comparison_that_is_never_asked_is_reported() {
8643 let f64 = Type::float(rucc_ir::Float::F64);
8644 let (mut names, mut source, block, args) = blank(&[f64, f64]);
8645 let (left, right) = two_long_doubles(&mut source, block, &args);
8646 let mut build = Builder::new(&mut source, block);
8647 build.fcmp(FloatPred::False, left, right, Flags::default());
8648 build.ret(&[]);
8649
8650 // Always false is a constant and not a comparison, so there is no condition to pick and
8651 // nothing here folds it into one: an instruction that quietly agreed with it would hide
8652 // that the optimizer left a comparison in that it should have taken out.
8653 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8654 .expect_err("no condition is always false");
8655 assert_eq!(failed.to_string(), "no rule lowers a `fcmp` producing a `i1`");
8656 }
8657
8658 #[test]
8659 fn a_long_double_constant_is_the_bits_of_it_put_where_the_value_lives() {
8660 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8661 let mut build = Builder::new(&mut source, block);
8662 // `1.5L`, which is the leading bit and one more of significand, and an exponent of zero.
8663 let one_and_a_half = build.fconst(long_double(), 0x3fff_c000_0000_0000_0000);
8664 build.store(one_and_a_half, args[0], plain(), Flags::default());
8665 build.ret(&[]);
8666
8667 // No x87 instruction at all. A slot holding one of these is the value, so a constant is
8668 // its ten bytes written where the value lives, and whatever reads it does the `fld`.
8669 let text = lower(&mut names, &source);
8670 assert!(text.contains("x64.mov_ri_64 -4611686018427387904"), "{text}");
8671 assert!(text.contains("x64.mov_ri_16 16383"), "{text}");
8672 assert!(text.contains("x64.mov_mr_16 %3, [%1 + 8]"), "{text}");
8673 // The six bytes above the ten are the padding that makes the type sixteen wide, and they
8674 // are unspecified rather than zero, so nothing writes them.
8675 assert_eq!(text.matches("x64.mov_mr").count(), 2, "{text}");
8676 }
8677
8678 #[test]
8679 fn a_negative_long_double_constant_keeps_the_bit_above_its_exponent() {
8680 let (mut names, mut source, block, args) = blank(&[Type::PTR]);
8681 let mut build = Builder::new(&mut source, block);
8682 let minus = build.fconst(long_double(), 0xbfff_c000_0000_0000_0000);
8683 build.store(minus, args[0], plain(), Flags::default());
8684 build.ret(&[]);
8685
8686 // `-1.5L`. The sign is the top bit of the two byte half, so the immediate that half is put
8687 // in a register with is above the signed range of sixteen bits and has to stay there: read
8688 // as a number it would be negative, and it is not a number, it is two bytes.
8689 let text = lower(&mut names, &source);
8690 assert!(text.contains("x64.mov_ri_16 49151"), "{text}");
8691 }
8692
8693 #[test]
8694 fn a_long_double_crosses_an_edge_as_an_address_and_is_copied_where_it_lands() {
8695 let (mut names, mut source, block, args) = blank(&[Type::float(rucc_ir::Float::F64)]);
8696 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8697 let next = source.create_block();
8698 let param = source.append_param(next, long_double());
8699 Builder::new(&mut source, block).jump(next, &[wide]);
8700 Builder::new(&mut source, next).ret(&[param]);
8701
8702 // What the edge carries is the address of the slot the value is already in, which is an
8703 // ordinary register the allocator has an opinion about. The block on the other side copies
8704 // the sixteen bytes into a slot of its own before anything reads them, so a second edge
8705 // handing over a second address would still leave one place for a reader to look.
8706 let text = lower(&mut names, &source);
8707 let second: Vec<&str> = text
8708 .lines()
8709 .skip_while(|line| !line.starts_with("block1"))
8710 .skip(1)
8711 .take(3)
8712 .map(str::trim)
8713 .collect();
8714 assert_eq!(
8715 second,
8716 ["x64.fld_t [%4]", "%5:gpr = x64.lea_64 [$rsp]", "x64.fstp_t [%5]"],
8717 "{text}"
8718 );
8719 }
8720
8721 #[test]
8722 fn more_long_doubles_at_a_block_than_the_stack_is_deep_are_reported() {
8723 let f64 = Type::float(rucc_ir::Float::F64);
8724 let (mut names, mut source, block, args) = blank(&[f64]);
8725 let wide = cast(&mut source, block, Opcode::FPExt, args[0], long_double());
8726 let next = source.create_block();
8727 let params: Vec<Value> =
8728 (0..=X87_DEPTH).map(|_| source.append_param(next, long_double())).collect();
8729 let carried: Vec<Value> = params.iter().map(|_| wide).collect();
8730 Builder::new(&mut source, block).jump(next, &carried);
8731 Builder::new(&mut source, next).ret(&[params[0]]);
8732
8733 // The copies go through the x87 stack so that every one of them is read before any of them
8734 // is written, which is what makes a block that swaps two of these right. Nine of them do
8735 // not fit on the stack, and copying the ninth before or after the rest is the order that
8736 // could be wrong, so it is refused instead.
8737 let failed = func(&source, &mut names, &SELECTOR, &SYSV, &Elsewhere::default())
8738 .expect_err("nine do not fit on the stack");
8739 assert_eq!(
8740 failed.to_string(),
8741 "block1 takes 9 parameters of type `f80` and only 8 can cross an edge at once"
8742 );
8743 assert_eq!(failed.inst(), None);
8744 }
8745}