rucc_codegen/abi.rs
1//! Where a function's arguments already are when it starts running, and where a call puts its own.
2//!
3//! Design: `spec/12-abi-and-runtime.md`.
4//!
5//! This is the one part of the calling convention that is not a lowering rule, and it is worth
6//! saying why, because everything else in this crate is. A rule matches a term and rewrites it,
7//! and which register the third argument arrives in is not a fact about any term: it depends on
8//! the argument's position and on the classification of every argument before it. A pattern has
9//! nowhere to put that. So the arguments are built here, by hand, out of what the convention
10//! says, the same way [`crate::finish`] builds a prologue.
11//!
12//! The classification itself is not here either. `rucc-lower` has already run it by the time a
13//! function reaches this crate, which is why the parameters read here are nearly all plain
14//! scalars: an aggregate has been split into the pieces it travels in, and a return through memory
15//! is an ordinary pointer parameter in front of the rest. What is left for this is the step after
16//! classification, from how a value travels to which register it is actually in, which is
17//! [`rucc_target::Places`].
18//!
19//! The one parameter that is not a scalar is an aggregate the classification put in the argument
20//! area whole, which is [`rucc_ir::Abi::ByVal`]. The IR calls it a pointer, because a pointer is
21//! what an instruction reading it has to have, and the convention says the bytes travel and the
22//! pointer does not. So this is the one place that reads what the classification said rather than
23//! only the type, on both sides of the call, and the two sides are the two halves of one copy.
24//!
25//! # What it writes
26//!
27//! One `x64.arg_val_*` per parameter that arrived in a register, at the top of the entry block,
28//! each defining a fresh register constrained to the one the argument arrived in. They encode to
29//! nothing. The point of them is that a parameter has to be defined somewhere for the allocator to
30//! have anything to move, and the entry block cannot define it as a block parameter: there is no
31//! edge into the entry block for the move to go on, which is what `rucc_regalloc::rewrite` asserts.
32//!
33//! What the allocator does with them is the whole of the argument sequence. A parameter that is
34//! read where it arrived costs nothing, and one that is not gets a copy, which is the same
35//! bargain the return already makes and is decided by the same code.
36//!
37//! A parameter whose bytes travelled is the exception to all of that. Its bytes are already in
38//! this function, at a place in the caller's argument area the same walk gives, so nothing is
39//! brought in at all: what the parameter is is where they are, and that is one `lea`. It waits on
40//! the frame the way the loads below it do, and for the same reason.
41//!
42//! A parameter past the last register arrived in the caller's memory rather than in a register, so
43//! it is a load and not a pseudo, and it is a real instruction that encodes to real bytes. How far
44//! up the caller's argument area it is is a number [`rucc_target::Places`] answers here, but where
45//! that area is from inside this function is a distance into a frame, and no frame exists until
46//! after allocation. So the load is written with nothing in its displacement, which of the two
47//! registers it reads through is left to be settled too, and both are filled in by [`crate::finish`]
48//! out of [`crate::frame::Frame::incoming`]. That is the same bargain an `alloca` already makes,
49//! for the same reason and in the same two places.
50//!
51//! # A call
52//!
53//! The same reasoning the other way round, and one instruction rather than several. `x64.call`
54//! and `x64.call_reg` are the only opcodes in the description whose operand vector is empty
55//! there, because nothing about a call's operands is the same from one call to the next, so they
56//! are built here: one read per argument constrained to the register the convention passes it in,
57//! one definition for the value that comes back constrained to the register it comes back in, and
58//! one definition per register the convention does not preserve.
59//!
60//! A call through an address has one operand more, which is the address, and it is the one
61//! operand of a call that is a fact about the instruction rather than about the signature. It
62//! goes in front of the arguments, because the assembler has to find it and an index into a
63//! vector whose length depends on the convention is not a way of finding anything.
64//!
65//! Those last ones are the clobbers, and they are the whole of what the allocator has to know
66//! about a call besides where the values go. Each is a definition of the physical register itself
67//! rather than of a value, since there is no value: it says the register is written here, which
68//! is exactly what stops the allocator from leaving something in one across the call. A register
69//! an argument or the result already names is not repeated, because naming it once already blocks
70//! it for the length of the instruction, which is all a clobber does.
71//!
72//! An argument past the last register the convention has for it is a store into the outgoing area
73//! rather than an operand of the call, written in front of the call in the same block. Where that
74//! area is does not have to wait for the frame the way the incoming one does, because the outgoing
75//! area is at the bottom of the frame and the bottom of the frame is where the stack pointer is:
76//! that is the whole reason the frame puts it there, since it is where the callee will look. So the
77//! offset [`rucc_target::Places`] gives back is the offset the store is written with.
78//!
79//! An object passed by value in memory is the same thing again and a copy rather than a store. The
80//! caller owes the callee a copy it is free to write to, which is what makes a C call by value
81//! different from passing a pointer the callee must not keep, and the argument area is where the
82//! convention says that copy goes. So the bytes are read out of the object and written into the
83//! area a word at a time, in front of the call, with the words chosen by the same function that
84//! chooses them for a `memcpy`. An object with more words than that unrolls to is copied by a call
85//! to the runtime's `memcpy` instead, written in front of the outer call in the same block.
86//!
87//! That is one call built in the middle of building another, which sounds worse than it is.
88//! Nothing of the outer call is in a physical register when the copy is written: every argument
89//! that travels in one is still a virtual register, and the register it has to end up in is a
90//! constraint on an operand of the call instruction, which is not built until every copy in front
91//! of it has been. So what the inner call destroys is what any call destroys, and the allocator
92//! keeps the outer call's values out of those registers the same way it does across a call the
93//! program wrote. The arguments already stored into the outgoing area are safe for a plainer
94//! reason: the inner call's own frame is below the stack pointer and that area is above it.
95//!
96//! The call still reports how many bytes it needed, because the frame reserves as many as the
97//! widest call in the function asked for and cannot know that until every call has been seen.
98
99use rucc_base::{Interner, Symbol};
100use rucc_ir::{Abi, Param, Type};
101use rucc_mir as mir;
102use rucc_target::x86_64;
103use rucc_target::{CallRegs, Constraint, PhysReg, Places, RegClass, Where};
104
105use crate::capability;
106use crate::varargs::Area;
107
108/// Why a parameter could not be brought in.
109#[derive(Debug, Clone, Copy, PartialEq, Eq)]
110pub enum Missing {
111 /// It travels on the x87 stack, which is a `long double` and nothing else. That stack is a
112 /// third register file, it is not one the allocator has, and no instruction in the
113 /// description touches it.
114 OnX87,
115 /// It is a width no pseudo covers, which is anything a machine register does not hold.
116 Width,
117 /// It is a value that comes back in more registers than the convention returns in. A structure
118 /// of at most sixteen bytes comes back in up to two, which is as many as SysV has, and a
119 /// convention with fewer of them returns such a structure through a hidden pointer instead. So
120 /// this is what a signature the classification did not produce would get.
121 NoRoom,
122 /// It is an object whose bytes travel in the argument area and there are more of them than
123 /// any count of them can be written down as. A copy too long to unroll is a call to the
124 /// runtime and not a refusal, so what is left here is an object of two gigabytes or more,
125 /// which is a size the immediate holding the byte count has nowhere to put and a structure no
126 /// program passes.
127 TooBig,
128}
129
130impl Missing {
131 /// What it says when a function could not be compiled because of it.
132 ///
133 /// Worded so that it reads the same about a value arriving and a value being passed, since
134 /// the two are the same fact seen from the two ends of one call.
135 #[must_use]
136 pub fn why(self) -> &'static str {
137 match self {
138 Missing::OnX87 => "is on the x87 stack",
139 Missing::Width => "is a width no argument register holds",
140 Missing::NoRoom => "takes more registers than this convention has for it",
141 Missing::TooBig => "is more bytes than a count of them can be written down as",
142 }
143 }
144}
145
146/// Which register file a value of that type travels in.
147///
148/// The whole of what the two files mean to this module. A float is in the vector one and
149/// everything else is in the general purpose one, which is what both of this machine's conventions
150/// say. A `long double` is in neither and what its register holds is an address, which is a general
151/// purpose value like every other address, so it answers with the other file rather than with the
152/// one its type would suggest.
153fn class_of(ty: Type, conv: &CallRegs) -> RegClass {
154 if ty.is_float() && !on_the_stack(ty) { conv.sse_class } else { conv.int_class }
155}
156
157/// How many bytes of the argument area a value in the vector file takes.
158///
159/// Its own width, lanes included, which is what [`Places::float`] wants and is a number that only
160/// matters to a value the registers ran out before. Everything the machine computes in is a word
161/// or narrower and takes a word either way. The `_Float128` is the one that is not: two words, and
162/// aligned to two words, which is the difference between the argument behind it being placed after
163/// it and being placed on top of half of it.
164pub(crate) fn float_bytes(ty: Type) -> u32 {
165 ty.bits().div_ceil(8).saturating_mul(ty.lanes())
166}
167
168/// Whether a value of that type travels as bytes in the argument area because of what it is.
169///
170/// One type does, and it is the `long double`. SysV classifies it X87 and X87UP, which is the
171/// classification that means memory, so it goes where a structure the classification put in memory
172/// goes and what the two ends pass is the address of the bytes. That is not a decision about
173/// registers running out: a `long double` travels in the argument area when it is the only argument
174/// there is.
175///
176/// Sixteen bytes aligned to sixteen, which is what the psABI says the type takes and is the same
177/// number [`crate::lower`] gives one in the frame, so a value being passed and a value being worked
178/// on are the same shape of object in two places.
179#[must_use]
180pub fn on_the_stack(ty: Type) -> bool {
181 ty.is_float() && ty.is_scalar() && ty.bits() == 80
182}
183
184/// How much room one takes in the argument area, as a size and an alignment.
185pub(crate) const X87_AREA: (u32, u32) = (16, 16);
186
187/// Why a value of that type cannot travel at all, or nothing if it can.
188///
189/// The width question and the file question in one place, so that the two ends of a call give the
190/// same answer about the same type, and so that a `return` this cannot make says the same thing
191/// about a type as the call that would have received it.
192///
193/// A `long double` is not one of them any more when it is an argument, since an argument of that
194/// type travels as bytes and [`on_the_stack`] is what says so before this is asked. What is left
195/// here is the value that comes back, because coming back is the one direction where it is not
196/// bytes: it arrives in `st(0)`, which is a register file this cannot name.
197#[must_use]
198pub fn refuses(ty: Type) -> Option<Missing> {
199 if head_of(ty).is_some() {
200 return None;
201 }
202 // A `long double` is the one type here that is in neither of the two files. Saying so is worth
203 // more than calling it a width, because eighty bits is a width this machine computes in and
204 // the file it computes in is what actually stands in the way.
205 if on_the_stack(ty) {
206 return Some(Missing::OnX87);
207 }
208 Some(Missing::Width)
209}
210
211/// What a function's parameters came to.
212#[derive(Debug, Default, Clone, PartialEq, Eq)]
213pub struct Arrived {
214 /// The register each parameter is in, in the order the parameters were given, so the caller can
215 /// bind each IR parameter to the one at its position.
216 pub regs: Vec<mir::Reg>,
217 /// The loads that read a parameter out of the caller's argument area, and how far up that area
218 /// each of them reads.
219 ///
220 /// Empty for almost every function, because almost every function has few enough parameters to
221 /// have been handed all of them in registers. The distance is from the bottom of the caller's
222 /// argument area, which is somewhere [`crate::finish`] works out and this cannot.
223 pub stack: Vec<(mir::Inst, u32)>,
224 /// How many general purpose argument registers the parameters took, and how many vector ones.
225 ///
226 /// Nothing about an ordinary function needs this. A variadic one does: the first argument its
227 /// signature does not name is the one after the last it does, so where each of the two walks
228 /// stopped is where `va_start` has to say the next argument begins.
229 pub took: (usize, usize),
230 /// How far up the caller's argument area the first argument the signature does not name is.
231 ///
232 /// However much of that area the named parameters took, on a convention that counts the two
233 /// register files apart, because there the area holds only the arguments no register was left
234 /// for. On one that counts them as one run it is not the same number: that area begins with the
235 /// shadow space the caller reserved, every argument owns one word of it whether it also arrived
236 /// in a register or not, and the named ones own the first few of those words. So it is where
237 /// the walk over the registers stopped, which is a position rather than a size, until the named
238 /// parameters have used every register and the two agree again.
239 pub beyond: u32,
240 /// The argument registers left over for the arguments the signature does not name, as the
241 /// register each was bound into and how far up the save area its slot is.
242 ///
243 /// Empty unless a save area was asked for. The ones a named parameter took are not here,
244 /// because their slots are behind where `va_start` sets the two offsets and nothing ever reads
245 /// them, so writing them would be fourteen stores where six are wanted.
246 pub spare: Vec<(mir::Reg, RegClass, u32)>,
247}
248
249/// Binds a function's parameters to where the convention says they arrive.
250///
251/// # Errors
252///
253/// The first parameter this cannot bring in, and why. A function with one is reported rather
254/// than compiled, because the alternative is a function that reads an argument from wherever the
255/// last one happened to leave a register.
256pub fn entry(
257 out: &mut mir::Func,
258 block: mir::Block,
259 params: &[Param],
260 conv: &CallRegs,
261 names: &mut Interner,
262 save: Option<Area>,
263) -> Result<Arrived, (usize, Missing)> {
264 // Where everything is, worked out before anything is written, both so that a parameter this
265 // cannot bring in stops the function before half of one is built and so that the two loops
266 // below can be two loops. Asking for the place of a parameter that cannot be brought in is
267 // still done, because every place after it depends on it and a reader stepping through this
268 // should see the same numbers a working version would.
269 let mut places = Places::new(conv);
270 let mut where_from = Vec::with_capacity(params.len());
271 for (index, &Param { ty, abi }) in params.iter().enumerate() {
272 // A structure the classification put in the argument area arrived as bytes, and the
273 // parameter the IR sees is a pointer to them. So there is nothing to bring in: the bytes
274 // are already in this function's frame, and what the pointer holds is where they are.
275 if let Abi::ByVal { size, align } = abi {
276 let size = u32::try_from(size).map_err(|_| (index, Missing::TooBig))?;
277 where_from.push((ty, places.on_stack(size, align), abi));
278 continue;
279 }
280 // And an eighty bit float, which arrives the same way for the same reason and is told
281 // apart only by the classification having said nothing about it: the front end passes it
282 // as a value of its own type, and it is this that knows the type is one that travels as
283 // bytes. What arrives is the address of those bytes, which is what an object in the
284 // argument area always hands over.
285 if on_the_stack(ty) {
286 let (size, align) = X87_AREA;
287 where_from.push((
288 ty,
289 places.on_stack(size, align),
290 Abi::ByVal { size: size.into(), align },
291 ));
292 continue;
293 }
294 let at = if ty.is_float() { places.float(float_bytes(ty)) } else { places.integer() };
295 if let Some(missing) = refuses(ty) {
296 return Err((index, missing));
297 }
298 where_from.push((ty, at, abi));
299 }
300 let took = (places.integers(), places.floats());
301 // Where the first argument the signature does not name is, which is the two sentences on
302 // [`Arrived::beyond`] written out. The run of words is contiguous from the bottom of the area on
303 // a convention that homes its register arguments, so a position multiplied by a word is the
304 // answer there until the positions run out and the named parameters start taking room of their
305 // own, at which point what they took is the answer again.
306 let reached = took.0 + took.1;
307 let beyond = match conv.shared_positions && reached < conv.int_args.len() {
308 true => conv.word * u32::try_from(reached).unwrap_or(0),
309 false => places.size(),
310 };
311 let mut arrived =
312 Arrived { regs: Vec::with_capacity(params.len()), took, beyond, ..Arrived::default() };
313
314 // Every pseudo first and everything else after, which is not a preference. A pseudo says a
315 // register holds an argument and defines nothing before it, so as far as the allocator can see
316 // the register was dead until then and is free to be used as a scratch. That is true of a
317 // register no pseudo has named yet, and it stops being true the moment one does. Anything that
318 // needs a scratch has to come after all of them, and a load out of the caller's stack needs one
319 // for the value it loads.
320 for (index, &(ty, at, _)) in where_from.iter().enumerate() {
321 let class = class_of(ty, conv);
322 let reg = out.new_vreg(class);
323 arrived.regs.push(reg);
324 let Where::Reg(arrived_in) = at else { continue };
325 let head = head_of(ty).ok_or((index, Missing::Width))?;
326 let opcode = mir::Opcode::new(names.intern(head));
327 let operand = mir::Operand::write(reg, class).with(Constraint::Fixed(arrived_in));
328 out.build(block, opcode).operand(operand).finish();
329 }
330 if let Some(area) = save {
331 arrived.spare = spare(out, block, conv, names, area, arrived.took);
332 }
333
334 let lea = format!("{}{}", crate::lower::PREFIX, x86_64::FRAME.lea);
335 // The stack pointer is written down as the register to read through because it is the one that
336 // reaches the caller's stack in almost every function, and a realigned frame is the exception
337 // that [`crate::finish`] rewrites. Putting something here rather than nothing keeps the
338 // instruction printable and verifiable in between.
339 for (index, &(ty, at, abi)) in where_from.iter().enumerate() {
340 let Where::Stack(up) = at else { continue };
341 let class = class_of(ty, conv);
342 // The bytes of an object that travelled as bytes are read by whatever reads the parameter,
343 // and what the parameter is is their address, so this takes the address rather than a
344 // value out of it. Everything else about it is the load's, including the two fields
345 // [`crate::finish`] fills in, because where the caller's argument area is is the same
346 // question for both.
347 let name = match abi {
348 Abi::ByVal { .. } => lea.as_str(),
349 _ => load_of(ty).ok_or((index, Missing::Width))?,
350 };
351 let opcode = mir::Opcode::new(names.intern(name));
352 let sp = mir::Operand::read(mir::Reg::physical(conv.stack_pointer), conv.int_class);
353 let made =
354 out.build(block, opcode).def(arrived.regs[index], class).mem(mir::Mem::at(sp)).finish();
355 arrived.stack.push((made, up));
356 }
357 Ok(arrived)
358}
359
360/// Binds the argument registers no parameter the signature names took, which are the ones the
361/// arguments it does not name arrived in.
362///
363/// One pseudo each and nothing else, for the reason the loop above them gives: what these do is say
364/// the register holds something, and the stores that put it in the save area are written by
365/// [`crate::lower`] once it has an address to store to, which is after every pseudo in the block.
366///
367/// Where each file's walk stopped is the file's own count on a convention that keeps two, and the
368/// sum of both on one that counts the files as a single run of positions, since there an argument
369/// of either kind steps the one counter. A file the area holds no slots of is skipped entirely,
370/// which is the vector file on the second kind: a variadic float travels in the general purpose
371/// register at its position as well, so the copy the walk reads is already the one being spilled.
372fn spare(
373 out: &mut mir::Func,
374 block: mir::Block,
375 conv: &CallRegs,
376 names: &mut Interner,
377 area: Area,
378 took: (usize, usize),
379) -> Vec<(mir::Reg, RegClass, u32)> {
380 let word = Type::int(64);
381 let double = Type::float(rucc_ir::Float::F64);
382 let reached = |own: usize| if conv.shared_positions { took.0 + took.1 } else { own };
383 let files = [
384 (conv.int_args, reached(took.0), word, false),
385 (conv.sse_args, reached(took.1), double, true),
386 ];
387 let mut spare = Vec::new();
388 for (regs, taken, ty, float) in files {
389 let held = usize::try_from(area.holds(float)).unwrap_or(0);
390 let Some(head) = head_of(ty) else { continue };
391 let class = class_of(ty, conv);
392 for (index, &arrived_in) in regs.iter().enumerate().take(held).skip(taken) {
393 let reg = out.new_vreg(class);
394 let opcode = mir::Opcode::new(names.intern(head));
395 let operand = mir::Operand::write(reg, class).with(Constraint::Fixed(arrived_in));
396 out.build(block, opcode).operand(operand).finish();
397 let at = area.starts_at(float) + area.stride(float) * u32::try_from(index).unwrap_or(0);
398 spare.push((reg, class, at));
399 }
400 }
401 spare
402}
403
404/// What the instruction that calls a name is called.
405///
406/// Here rather than in a rule for the same reason the arguments are: a rule pattern sees one term
407/// and a call's operands are whatever the signature made them, so no pattern could name them.
408pub const CALL: &str = "x64.call";
409
410/// What the instruction that calls an address in a register is called.
411///
412/// A different instruction rather than the same one with a different operand, which is what the
413/// machine says too: one carries the distance to somewhere in the program and takes a relocation,
414/// and the other carries the register the address is in and takes none. Sharing an opcode would
415/// mean an instruction whose bytes depend on whether a field beside it happens to be set.
416pub const CALL_REG: &str = "x64.call_reg";
417
418/// One value a call passes.
419#[derive(Debug, Clone, Copy, PartialEq, Eq)]
420pub struct Passing {
421 /// The type it travels as, which for an object travelling as bytes is the pointer's rather
422 /// than the object's, because the pointer is what the machine IR has.
423 pub ty: Type,
424 /// The register holding it, or holding its address when the bytes are what travel.
425 pub reg: mir::Reg,
426 /// What the classification asked of it. The one thing read here is whether the object behind
427 /// the pointer is the argument, since everything else it can say is about a value that is
428 /// already in a register in the form it travels in.
429 pub abi: Abi,
430}
431
432/// What one call came to.
433#[derive(Debug, Clone, PartialEq, Eq)]
434pub struct Made {
435 /// The registers the value came back in, in the order the signature returns them, which is
436 /// empty for a call that gives nothing back and holds two for a structure that comes back in a
437 /// pair. Which register each of them is is the classification's answer and is worked out here
438 /// rather than in a table, for the reason the second half of [`Calling::returns`] gives.
439 pub results: Vec<mir::Reg>,
440 /// How many bytes below the stack pointer this call needs for the arguments it passes there.
441 ///
442 /// Not always zero for a call that passes everything in registers: a Windows caller reserves
443 /// thirty two bytes for the callee to spill its register arguments into whether it uses them
444 /// or not, and that reservation is this.
445 pub outgoing: u32,
446}
447
448/// Which of a call's values could not be passed, and why.
449#[derive(Debug, Clone, Copy, PartialEq, Eq)]
450pub struct Refused {
451 /// Its position among the arguments, or `None` for the value that comes back.
452 pub argument: Option<usize>,
453 /// What is wrong with where it travels.
454 pub missing: Missing,
455}
456
457/// What a call goes to.
458///
459/// The whole of the difference between the two calls. Everything else about them, which is what
460/// they pass and what comes back and which registers they destroy, is the signature's answer and
461/// is the same answer either way.
462#[derive(Debug, Clone, Copy, PartialEq, Eq)]
463pub enum Callee {
464 /// A name, which the linker resolves.
465 Named(Symbol),
466 /// An address in a register, which nothing resolves because there is nothing to resolve: the
467 /// value is not known until the program runs.
468 ///
469 /// The register is unconstrained, and it has to be, because every register the convention
470 /// does not preserve is one this instruction writes and every register an argument travels in
471 /// is spoken for. What is left is the registers the callee has to put back, which is where
472 /// the allocator will put the address, and it is the right answer for the same reason it is
473 /// the only one.
474 Through(mir::Reg),
475}
476
477/// One call, as everything about it that is not the function it is being built into.
478#[derive(Debug, Clone, Copy)]
479pub struct Calling<'a> {
480 /// What it calls.
481 pub callee: Callee,
482 /// What it passes, in the order the signature holds them, which is the order the convention
483 /// places them in.
484 pub args: &'a [Passing],
485 /// What comes back, which is empty for a call that gives nothing back, one type for a value,
486 /// and two for a structure small enough to come back in a pair of registers.
487 ///
488 /// A pair is placed here rather than named by a rule for the reason the arguments are: which
489 /// register each half goes in depends on the halves before it, since the two files are walked
490 /// separately, and a pattern over a term cannot see them.
491 pub returns: &'a [Type],
492 /// Whether the callee takes arguments beyond the ones its signature names, which is what says
493 /// whether it reads the count of vector registers the call passed arguments in.
494 pub variadic: bool,
495 /// How many of the arguments the signature does name, so that the ones past it can be told
496 /// apart from the ones before it.
497 ///
498 /// A convention that passes a variadic float in both register files needs that, because which
499 /// arguments get the second copy is exactly the ones the callee has no prototype for. Every
500 /// other convention treats the two the same and never asks.
501 pub named: usize,
502}
503
504/// Builds one call: what it passes, what comes back, and what it destroys.
505///
506/// # Errors
507///
508/// The first value this cannot pass, and why, before anything is written. A call with one is
509/// reported rather than compiled, because the alternative is a call that leaves an argument
510/// wherever the last one happened to put a register.
511///
512/// # Panics
513///
514/// If a call passes two gigabytes of arguments on the stack, which is a distance no offset in a
515/// frame can hold and a call no program makes.
516pub fn call(
517 out: &mut mir::Func,
518 block: mir::Block,
519 made: &Calling<'_>,
520 conv: &CallRegs,
521 names: &mut Interner,
522) -> Result<Made, Refused> {
523 let &Calling { callee, args, returns, variadic, named } = made;
524 // Where everything goes, worked out before anything is built, so that a call this cannot make
525 // leaves no half of one behind.
526 let mut places = Places::new(conv);
527 let mut passed = Vec::with_capacity(args.len());
528 // The ones with no register left for them, as the store each of them becomes and how far up
529 // the outgoing area it writes. Almost always empty.
530 let mut on_stack = Vec::new();
531 // How many of them went in vector registers, which is what a SysV variadic callee is told.
532 let mut vectors = 0u32;
533 // The ones whose bytes travel rather than their address, as the register that address is in,
534 // how far up the outgoing area they go and which words the copy is made of. Almost always
535 // empty too, and never at the same time as a register: an object in the argument area is in
536 // the argument area whatever is left of the register files.
537 let mut as_bytes = Vec::new();
538 // The arguments beyond the ones the signature names that travel in a vector register and have
539 // to travel in a general purpose one at the same time, as the register each is in and the
540 // general purpose register its copy belongs in. Empty on every convention but the one that says
541 // so, and on that one this is what makes `printf("%f", x)` read the right register.
542 let mut in_both = Vec::new();
543 // Which argument position the next one that gets a register is at, which is only the same as
544 // the index when nothing ahead of it went to memory. A convention that counts the two register
545 // files as one run is what needs it: the general purpose register a variadic float's second
546 // copy goes in is the one at that position.
547 let mut position = 0usize;
548 for (index, &Passing { ty, reg, abi }) in args.iter().enumerate() {
549 let refused = |missing| Refused { argument: Some(index), missing };
550 // An eighty bit float is bytes in the argument area whatever the classification said, for
551 // the reason [`on_the_stack`] gives, and the register holding it holds their address. So it
552 // joins the objects below rather than being a case of its own, and the copy it becomes is
553 // the copy any other sixteen byte object gets.
554 let abi = match abi {
555 _ if on_the_stack(ty) => {
556 let (size, align) = X87_AREA;
557 Abi::ByVal { size: size.into(), align }
558 }
559 abi => abi,
560 };
561 if let Abi::ByVal { size, align } = abi {
562 let size = u32::try_from(size).map_err(|_| refused(Missing::TooBig))?;
563 let Where::Stack(up) = places.on_stack(size, align) else {
564 unreachable!("an object in the argument area is in the argument area")
565 };
566 // Nothing here refuses a plan it did not get, because a copy the words give up on is
567 // a call to the runtime below. What the byte count has to fit in is the immediate the
568 // call passes it as, and an object that large is what is left of the old refusal.
569 let plan = crate::expand::plan(u64::from(size), align, conv.word);
570 let count = i32::try_from(size).map_err(|_| refused(Missing::TooBig))?;
571 as_bytes.push((reg, up, count, plan));
572 continue;
573 }
574 let at = if ty.is_float() { places.float(float_bytes(ty)) } else { places.integer() };
575 if let Some(missing) = refuses(ty) {
576 return Err(refused(missing));
577 }
578 let class = class_of(ty, conv);
579 match at {
580 Where::Reg(at) => {
581 // Only a register counts, because the count is of registers. An argument that went
582 // to memory is one the callee reads from memory whatever this says.
583 if class == conv.sse_class {
584 vectors += 1;
585 // Windows passes a float the callee has no prototype for in the vector register
586 // and in the general purpose register at the same position, both at once,
587 // because the callee has no way to know which file to look in and its walk over
588 // the arguments reads the second one. An argument the signature does name needs
589 // no second copy, since the callee's parameter says where it is.
590 let both = conv.shared_positions && variadic && index >= named;
591 if let Some(&also) = conv.int_args.get(position).filter(|_| both) {
592 in_both.push((reg, also));
593 }
594 }
595 passed.push((reg, at, class));
596 position += 1;
597 }
598 Where::Stack(up) => {
599 let store = store_of(ty).ok_or(refused(Missing::Width))?;
600 on_stack.push((reg, class, names.intern(store), up));
601 }
602 }
603 }
604 // A `long double` comes back in `st(0)`, which is not a register in either file and not one
605 // this call can be said to write. So nothing is placed for it and nothing is constrained, and
606 // the call gives back no register at all: what takes the value off that stack is the `fstp`
607 // [`crate::lower`] writes straight after the call, which is the same shape every other use of
608 // the x87 stack is written in. Only on its own, because a value that comes back beside another
609 // one comes back in a pair of registers and there is no pair with that stack in it.
610 let comes_back = if matches!(returns, [ty] if on_the_stack(*ty)) {
611 Vec::new()
612 } else {
613 places_back(returns, conv)?
614 };
615
616 // A variadic callee on SysV reads how many vector registers the call passed arguments in and
617 // skips saving them when the answer is none, which is what makes `printf` with no floating
618 // point argument cheap. It is an obligation rather than an optimization: leaving whatever was
619 // in the register there makes the callee save a register file it was not given, and a count
620 // that is too low makes it read an argument out of a register nothing put one in.
621 let counted = if variadic { conv.vector_count } else { None };
622
623 // The arguments that go to memory go there now, in front of the call and after everything this
624 // could have refused, so that a call it cannot make leaves no store behind either. The offset
625 // is written straight in rather than left for [`crate::finish`]: the outgoing area is at the
626 // bottom of the frame because that is where the callee looks for it, and the bottom of the
627 // frame is where the stack pointer already is.
628 for (reg, class, store, up) in on_stack {
629 let sp = mir::Operand::read(mir::Reg::physical(conv.stack_pointer), conv.int_class);
630 let up = i32::try_from(up).expect("an argument area under two gigabytes");
631 let build = out.build(block, mir::Opcode::new(store));
632 build.uses(reg, class).mem(mir::Mem::at(sp).plus(up)).finish();
633 }
634
635 // How many bytes the copies below needed for calls of their own, which is nothing on a
636 // convention that passes three pointers in registers and thirty two bytes on the one that
637 // reserves a place for them anyway. The frame has to hear about it, since a call built here is
638 // still a call this function makes.
639 let mut nested = 0u32;
640
641 // And the objects whose bytes go there, as a load and a store for each word of each of them.
642 // This is the copy the caller owes a callee that takes a structure by value: the callee is
643 // free to write to what it was handed, so what it was handed cannot be the caller's own copy,
644 // and the argument area is where the convention says the caller's copy goes. The words are the
645 // same words `crate::expand` would have chosen for a `memcpy` of the same block, because they
646 // are chosen by the same function.
647 for (from, up, count, plan) in as_bytes {
648 let up = i32::try_from(up).expect("an argument area under two gigabytes");
649 let Some(plan) = plan else {
650 nested = nested.max(by_runtime(out, block, conv, names, from, up, count));
651 continue;
652 };
653 for (at, width) in plan {
654 let ty = Type::int(width * 8);
655 let at = i32::try_from(at).expect("an object under two gigabytes");
656 let word = out.new_vreg(conv.int_class);
657 let load = names
658 .intern(load_of(ty).ok_or(Refused { argument: None, missing: Missing::Width })?);
659 let there = mir::Operand::read(from, conv.int_class);
660 let build = out.build(block, mir::Opcode::new(load));
661 build.def(word, conv.int_class).mem(mir::Mem::at(there).plus(at)).finish();
662 let store = names
663 .intern(store_of(ty).ok_or(Refused { argument: None, missing: Missing::Width })?);
664 let sp = mir::Operand::read(mir::Reg::physical(conv.stack_pointer), conv.int_class);
665 let build = out.build(block, mir::Opcode::new(store));
666 build.uses(word, conv.int_class).mem(mir::Mem::at(sp).plus(up + at)).finish();
667 }
668 }
669
670 // And the second copy of each float the callee has no prototype for, which is one `movq` out of
671 // the vector register it is already in. What the callee reads out of the general purpose
672 // register is the sixty four bits and not a value of any type, so the bits are what move, and
673 // the copy joins the arguments rather than being a thing of its own: it is passed in a register
674 // the convention names, which is what every other argument here is.
675 for (from, into) in in_both {
676 let word = out.new_vreg(conv.int_class);
677 let movq = mir::Opcode::new(names.intern("x64.movq_from_xmm"));
678 out.build(block, movq).def(word, conv.int_class).uses(from, conv.sse_class).finish();
679 passed.push((word, into, conv.int_class));
680 }
681
682 // The definitions first and the reads after, which is the order every operand vector in the
683 // machine IR is in and the order `rucc_mir::defs` counts.
684 let mut operands = Vec::with_capacity(args.len() + conv.int_order.len() + 2);
685 let results: Vec<mir::Reg> = comes_back
686 .iter()
687 .map(|&(at, class)| {
688 let reg = out.new_vreg(class);
689 operands.push(mir::Operand::write(reg, class).with(Constraint::Fixed(at)));
690 reg
691 })
692 .collect();
693 // One list per file, because a physical register is a number and the class is what says which
694 // file it is a number in. One list would have `xmm0` blocking `rax`.
695 let spoken_for = |class: RegClass| -> Vec<PhysReg> {
696 comes_back
697 .iter()
698 .filter(|&&(_, at)| at == class)
699 .map(|&(reg, _)| reg)
700 .chain(counted.filter(|_| class == conv.int_class))
701 .chain(passed.iter().filter(|&&(_, _, at)| at == class).map(|&(_, reg, _)| reg))
702 .collect()
703 };
704 let named = spoken_for(conv.int_class);
705 for ® in conv.int_order {
706 if !conv.preserves_int(reg) && !named.contains(®) {
707 operands.push(mir::Operand::write(mir::Reg::physical(reg), conv.int_class));
708 }
709 }
710 let named = spoken_for(conv.sse_class);
711 for ® in conv.sse_order {
712 if !conv.preserves_sse(reg) && !named.contains(®) {
713 operands.push(mir::Operand::write(mir::Reg::physical(reg), conv.sse_class));
714 }
715 }
716 // The address in front of the arguments, because a call through one is written with the
717 // register it goes through and nothing in the operand vector is at a place a table could name.
718 // First read is a place that does not depend on the signature, which is what
719 // [`rucc_target::x86_64::Arg::Through`] is written against.
720 if let Callee::Through(reg) = callee {
721 operands.push(mir::Operand::read(reg, conv.int_class));
722 }
723 for (reg, at, class) in passed {
724 operands.push(mir::Operand::read(reg, class).with(Constraint::Fixed(at)));
725 }
726 if let Some(at) = counted {
727 let count = out.new_vreg(conv.int_class);
728 let zero = mir::Opcode::new(names.intern("x64.mov_ri_32"));
729 out.build(block, zero).def(count, conv.int_class).imm(i64::from(vectors)).finish();
730 operands.push(mir::Operand::read(count, conv.int_class).with(Constraint::Fixed(at)));
731 }
732
733 let opcode = mir::Opcode::new(names.intern(match callee {
734 Callee::Named(_) => CALL,
735 Callee::Through(_) => CALL_REG,
736 }));
737 let mut build = out.build(block, opcode);
738 if let Callee::Named(symbol) = callee {
739 build = build.symbol(symbol);
740 }
741 for operand in operands {
742 build = build.operand(operand);
743 }
744 build.finish();
745 Ok(Made { results, outgoing: places.size().max(nested) })
746}
747
748/// One object with more words than a copy into the argument area unrolls to, copied there by a
749/// call to the runtime, and how many bytes that call itself needed below the stack pointer.
750///
751/// Which routine it is is [`crate::capability`]'s answer and not a name written here, because a
752/// call standing in for an operation the machine has no instruction for is what that table is a
753/// list of, and a copy too large to unroll is already on it: this is the same row `crate::expand`
754/// reads for a `memcpy` in the IR of the same size.
755fn by_runtime(
756 out: &mut mir::Func,
757 block: mir::Block,
758 conv: &CallRegs,
759 names: &mut Interner,
760 from: mir::Reg,
761 up: i32,
762 count: i32,
763) -> u32 {
764 let routine = capability::libcall(rucc_ir::Opcode::Memcpy, "big")
765 .expect("the runtime copies a block too large to unroll");
766
767 // Where the copy goes, which is a distance up the outgoing area and so is the stack pointer
768 // plus that distance. A `lea` rather than an add, because the stack pointer is not this
769 // function's to move and what the call wants is the address in a register of the allocator's
770 // choosing.
771 let sp = mir::Operand::read(mir::Reg::physical(conv.stack_pointer), conv.int_class);
772 let into = out.new_vreg(conv.int_class);
773 let lea = mir::Opcode::new(names.intern("x64.lea_64"));
774 out.build(block, lea).def(into, conv.int_class).mem(mir::Mem::at(sp).plus(up)).finish();
775
776 // And how many bytes, which C takes as a `size_t` and this has as a number. A thirty two bit
777 // move carries it, because writing the low half of a general purpose register clears the high
778 // half, so the sixty four bit count it becomes is the count as long as the count fits in the
779 // immediate, which is what the caller checked before anything was built.
780 let bytes = out.new_vreg(conv.int_class);
781 let mov = mir::Opcode::new(names.intern("x64.mov_ri_32"));
782 out.build(block, mov).def(bytes, conv.int_class).imm(i64::from(count)).finish();
783
784 let args = [
785 Passing { ty: Type::PTR, reg: into, abi: Abi::Plain },
786 Passing { ty: Type::PTR, reg: from, abi: Abi::Plain },
787 Passing { ty: Type::int(conv.word * 8), reg: bytes, abi: Abi::Plain },
788 ];
789 let made = Calling {
790 callee: Callee::Named(names.intern(routine)),
791 args: &args,
792 returns: &[],
793 variadic: false,
794 named: args.len(),
795 };
796 // Three pointer sized arguments and nothing coming back is a call every convention here has
797 // registers for, so the only way this could refuse is a convention with fewer than three
798 // argument registers, and there is no such convention.
799 call(out, block, &made, conv, names)
800 .expect("the runtime's copy passes three words and takes nothing back")
801 .outgoing
802}
803
804/// Which register each value comes back in, walked the way the arguments are.
805///
806/// The two files are counted separately, because a structure of a `double` and a `long` comes back
807/// with the `double` in the first vector register and the `long` in the first integer one, and a
808/// single count would put the second half one place further along a list it is not on.
809///
810/// # Errors
811///
812/// The first value that cannot come back at all, and why, so that a call this cannot make leaves
813/// nothing behind. Nothing here reports which value it was, because the caller has one answer for
814/// all of them: the value that comes back is not an argument and has no position among them.
815fn places_back(returns: &[Type], conv: &CallRegs) -> Result<Vec<(PhysReg, RegClass)>, Refused> {
816 let refused = |missing| Refused { argument: None, missing };
817 let mut back = Vec::with_capacity(returns.len());
818 let (mut ints, mut sses) = (0usize, 0usize);
819 for &ty in returns {
820 if let Some(missing) = refuses(ty) {
821 return Err(refused(missing));
822 }
823 let class = class_of(ty, conv);
824 let (file, at) = if class == conv.sse_class {
825 (conv.sse_returns, &mut sses)
826 } else {
827 (conv.int_returns, &mut ints)
828 };
829 let reg = *file.get(*at).ok_or_else(|| refused(Missing::NoRoom))?;
830 *at += 1;
831 back.push((reg, class));
832 }
833 Ok(back)
834}
835
836/// Which of the four widths a value travels at, where a truth value travels as the byte it lives
837/// in.
838///
839/// [`crate::term::slot`] is the question the rule set asks and it answers nothing for one bit,
840/// because there is no register of that width and so no instruction written at it. A convention
841/// asks a different question. It has nothing narrower than a byte to put an argument in either,
842/// and what it says about the one type that is a bit is that the byte holding it is the argument,
843/// with the seven bits above unspecified. So the two lists differ by exactly this entry.
844///
845/// It is written here and not in [`crate::term::slot`] because moving it there would tell the rule
846/// set that one bit is a byte, and then every byte rule in the file would match a term that is not
847/// one. What the convention needs is narrower: a name for the register an argument arrives in, and
848/// that name says a width because a listing is easier to read when it does.
849fn place(ty: Type) -> Option<usize> {
850 if crate::term::is_bit(ty) { Some(0) } else { crate::term::slot(ty) }
851}
852
853/// What the pseudo for an argument of that type is called.
854///
855/// The width is in the name for the same reason it is in every other opcode here: it is what the
856/// instruction is about. Nothing encodes it, so nothing depends on it being right, but a listing
857/// that says an argument arrived and does not say how much of it did is a listing worth less.
858///
859/// Which widths there are is `place` above, and not a list of its own, because it has to be the
860/// same list the three below use. An argument brought in at a width nothing downstream has a name
861/// for is a register nothing could then read, and a width the others cover that this refuses is a
862/// function turned away for no reason. Asking one question in one place is what keeps the four
863/// answers from drifting, and an address is what they used to disagree about.
864#[must_use]
865pub fn head_of(ty: Type) -> Option<&'static str> {
866 // The format that fills a whole vector register, which travels in one of them: the psABI
867 // classifies it SSE and SSEUP, and those two eightbytes are the one register the pair names
868 // rather than two registers.
869 if crate::term::is_quad(ty) {
870 return Some("x64.arg_val_f128");
871 }
872 if let Some(at) = crate::term::float_slot(ty) {
873 return Some(["x64.arg_val_f32", "x64.arg_val_f64"][at]);
874 }
875 let names = ["x64.arg_val_8", "x64.arg_val_16", "x64.arg_val_32", "x64.arg_val_64"];
876 Some(names[place(ty)?])
877}
878
879/// What the instruction that reads an argument of that type out of memory is called.
880///
881/// Keyed off the same two questions [`head_of`] asks and answering for the same set of types, so
882/// that a parameter this compiler can bring in from a register is one it can bring in from the
883/// caller's stack as well. A width one of them covered and the other did not would be a function
884/// turned away for where its sixth argument happened to land.
885///
886/// Reading a narrow argument at its own width and not at a word is deliberate. The caller wrote a
887/// whole word, but what it put in the part above the value is not something the convention says, so
888/// the bits this reads are exactly the bits that mean anything. That is the same thing an argument
889/// arriving in a register gets: `x64.arg_val_8` says the low byte of that register is the argument
890/// and says nothing at all about the rest of it.
891#[must_use]
892pub fn load_of(ty: Type) -> Option<&'static str> {
893 // Sixteen bytes, which is the whole register and is also the whole value, so the instruction
894 // a spill uses and the instruction an argument uses are the same one here. They are two
895 // different instructions at the two narrower formats because there the value is part of the
896 // register, and at this format there is no part of it to leave behind.
897 if crate::term::is_quad(ty) {
898 return Some("x64.movaps_rm");
899 }
900 if let Some(at) = crate::term::float_slot(ty) {
901 return Some(["x64.movss_rm", "x64.movsd_rm"][at]);
902 }
903 let names = ["x64.mov_rm_8", "x64.mov_rm_16", "x64.mov_rm_32", "x64.mov_rm_64"];
904 Some(names[place(ty)?])
905}
906
907/// What the instruction that writes an argument of that type into memory is called.
908///
909/// The mirror of [`load_of`], keyed off the same two questions and answering for the same set of
910/// types, so that the two ends of one call agree about what travels. A type a callee can read out
911/// of the argument area and a caller cannot write into it would be a call turned away for a reason
912/// the function it calls does not have.
913///
914/// Writing a narrow argument at its own width leaves whatever was already in the rest of the word.
915/// That is allowed, and it is what [`load_of`] is written against: the convention does not say what
916/// is above the value, so the callee reads only the bits that mean anything and neither end has to
917/// agree about the rest.
918#[must_use]
919pub fn store_of(ty: Type) -> Option<&'static str> {
920 if crate::term::is_quad(ty) {
921 return Some("x64.movaps_mr");
922 }
923 if let Some(at) = crate::term::float_slot(ty) {
924 return Some(["x64.movss_mr", "x64.movsd_mr"][at]);
925 }
926 let names = ["x64.mov_mr_8", "x64.mov_mr_16", "x64.mov_mr_32", "x64.mov_mr_64"];
927 Some(names[place(ty)?])
928}
929
930/// What the instruction that leaves a returned value in its register is called, for the value at
931/// that place in its own register file.
932///
933/// Keyed off the same two questions [`head_of`] asks, so a type this can give back is a type it can
934/// take in. The place is the one a call counted to when it laid the return out, which is per file
935/// rather than over the whole list: a structure of a `double` and a `long` gives both of them back
936/// at place zero.
937///
938/// The register itself is not here. It is in the operand table in `rucc_target::x86_64`, which is
939/// where the first one has always been, and the two names below are how a value says which of the
940/// two it is. A convention with more than two registers to come back in would need more names, and
941/// there is none, which is what the `None` at the end is about.
942#[must_use]
943pub fn ret_of(ty: Type, at: usize) -> Option<&'static str> {
944 if crate::term::is_quad(ty) {
945 return Some(*["x64.ret_val_f128", "x64.ret_val2_f128"].get(at)?);
946 }
947 if let Some(width) = crate::term::float_slot(ty) {
948 let names =
949 [["x64.ret_val_f32", "x64.ret_val_f64"], ["x64.ret_val2_f32", "x64.ret_val2_f64"]];
950 return Some(names.get(at)?[width]);
951 }
952 let names = [
953 ["x64.ret_val_8", "x64.ret_val_16", "x64.ret_val_32", "x64.ret_val_64"],
954 ["x64.ret_val2_8", "x64.ret_val2_16", "x64.ret_val2_32", "x64.ret_val2_64"],
955 ];
956 Some(names.get(at)?[place(ty)?])
957}
958
959#[cfg(test)]
960mod tests {
961 use rucc_target::x86_64::{REGS, SYSV, WIN64};
962
963 use super::*;
964
965 /// Those types as parameters that travel as the values they are, which is every one of them
966 /// that is not a structure the classification put in the argument area.
967 fn plain(params: &[Type]) -> Vec<Param> {
968 params.iter().copied().map(Param::new).collect()
969 }
970
971 /// The parameters of a function under a convention, as machine IR text.
972 fn bind(params: &[Type], conv: &CallRegs) -> String {
973 let mut names = Interner::new();
974 let mut out = mir::Func::new(names.intern("f"));
975 let block = out.create_block();
976 entry(&mut out, block, &plain(params), conv, &mut names, None)
977 .expect("every parameter arrives");
978 mir::print_func(&out, &names, ®S)
979 }
980
981 #[test]
982 fn the_first_arguments_arrive_where_the_convention_puts_them() {
983 let i32 = Type::int(32);
984 assert_eq!(
985 bind(&[i32, i32, Type::int(64)], &SYSV),
986 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
987 %1:gpr($rsi) = x64.arg_val_32\n %2:gpr($rdx) = x64.arg_val_64\n}\n"
988 );
989 }
990
991 #[test]
992 fn the_other_convention_puts_the_same_arguments_somewhere_else() {
993 // The first argument is in `rcx` here and in `rdi` above, which is the difference that
994 // makes a SysV binary calling a Windows one read the wrong value rather than fail.
995 let i64 = Type::int(64);
996 assert_eq!(
997 bind(&[i64, i64], &WIN64),
998 "mfunc @f {\nblock0:\n %0:gpr($rcx) = x64.arg_val_64\n \
999 %1:gpr($rdx) = x64.arg_val_64\n}\n"
1000 );
1001 }
1002
1003 /// The parameters of a function under a convention, and what each of the ones that arrived in
1004 /// memory is waiting on.
1005 fn arrive(params: &[Type], conv: &CallRegs) -> (String, Vec<u32>) {
1006 let mut names = Interner::new();
1007 let mut out = mir::Func::new(names.intern("f"));
1008 let block = out.create_block();
1009 let arrived = entry(&mut out, block, &plain(params), conv, &mut names, None)
1010 .expect("every parameter");
1011 let up = arrived.stack.iter().map(|&(_, up)| up).collect();
1012 (mir::print_func(&out, &names, ®S), up)
1013 }
1014
1015 #[test]
1016 fn an_argument_past_the_last_register_is_read_out_of_the_caller_s_stack() {
1017 let (text, up) = arrive(&[Type::int(64); 7], &SYSV);
1018
1019 // Six of them got registers and the seventh did not, so the seventh is a load rather than
1020 // a pseudo. It reads through the stack pointer with nothing in its displacement, because
1021 // where the caller's argument area is from in here is a distance into a frame that does
1022 // not exist yet, and it is at the bottom of that area because it is the first one in it.
1023 assert_eq!(up, [0]);
1024 assert!(text.contains("%6:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
1025 assert_eq!(text.matches("x64.arg_val_64").count(), 6, "{text}");
1026 }
1027
1028 #[test]
1029 fn the_other_convention_runs_out_of_registers_three_arguments_earlier() {
1030 let (text, up) = arrive(&[Type::int(64); 7], &WIN64);
1031
1032 // Windows passes four integers in registers and reserves thirty two bytes below the call
1033 // whether they are used or not, so the fifth argument is not at the bottom of the argument
1034 // area but above the shadow space, and the three after it follow it a word at a time.
1035 assert_eq!(up, [32, 40, 48]);
1036 assert_eq!(text.matches("x64.arg_val_64").count(), 4, "{text}");
1037 assert!(text.contains("%4:gpr = x64.mov_rm_64 [$rsp]"), "{text}");
1038 }
1039
1040 /// The parameters of a function under a convention, with one of them a structure whose bytes
1041 /// travel, and what each of the ones that arrived in memory is waiting on.
1042 fn arrive_with(params: &[Param], conv: &CallRegs) -> (String, Vec<u32>) {
1043 let mut names = Interner::new();
1044 let mut out = mir::Func::new(names.intern("f"));
1045 let block = out.create_block();
1046 let arrived =
1047 entry(&mut out, block, params, conv, &mut names, None).expect("every parameter");
1048 let up = arrived.stack.iter().map(|&(_, up)| up).collect();
1049 (mir::print_func(&out, &names, ®S), up)
1050 }
1051
1052 #[test]
1053 fn a_structure_that_arrived_as_bytes_is_an_address_and_not_a_load() {
1054 let byval = Param::with_abi(Type::PTR, Abi::ByVal { size: 32, align: 8 });
1055 let (text, up) =
1056 arrive_with(&[Param::new(Type::int(32)), byval, Param::new(Type::int(32))], &SYSV);
1057
1058 // `int f(int a, struct Big b, int c)`. The bytes of `b` are already in this function, at
1059 // the bottom of the caller's argument area, so nothing is read out of them here: what the
1060 // parameter is is where they are, which is one address. The two integers still travel in
1061 // registers, because an object in the argument area takes no register and the arguments
1062 // behind it do not shift along.
1063 assert_eq!(up, [0]);
1064 assert_eq!(text.matches("x64.arg_val_32").count(), 2, "{text}");
1065 assert!(text.contains("%2:gpr = x64.lea_64 [$rsp]"), "{text}");
1066 assert!(!text.contains("mov_rm"), "nothing is read out of the bytes: {text}");
1067 }
1068
1069 #[test]
1070 fn the_argument_behind_a_structure_that_travelled_as_bytes_is_above_all_of_them() {
1071 let byval = Param::with_abi(Type::PTR, Abi::ByVal { size: 24, align: 16 });
1072 let params: Vec<Param> = (0..7).map(|_| Param::new(Type::int(64))).collect();
1073 let (_, up) = arrive_with(&[¶ms[..], &[byval], ¶ms[..1]].concat(), &SYSV);
1074
1075 // Six integers take the six registers, the seventh is at the bottom of the argument area,
1076 // and the structure is above it at the alignment its type asks for rather than at a word.
1077 // The one behind the structure is above all twenty four of its bytes, rounded up to a
1078 // whole number of words, because the area is a run of words.
1079 assert_eq!(up, [0, 16, 40]);
1080 }
1081
1082 /// A parameter narrower than a word is read at its own width rather than at a word, and one in
1083 /// the other register file is read with the other file's instruction. Both are the same list
1084 /// [`head_of`] answers from, which is what stops a function being turned away for the width of
1085 /// its seventh argument alone.
1086 #[test]
1087 fn what_a_stack_argument_is_read_with_is_its_own_width_and_its_own_file() {
1088 let f32 = Type::float(rucc_ir::Float::F32);
1089 let params = [Type::int(64), Type::int(64), Type::int(64), Type::int(64), Type::int(8)];
1090 let (text, up) = arrive(¶ms, &WIN64);
1091 assert_eq!(up, [32]);
1092 assert!(text.contains("x64.mov_rm_8 [$rsp]"), "{text}");
1093
1094 let floats = [f32; 5];
1095 let (text, up) = arrive(&floats, &WIN64);
1096 assert_eq!(up, [32]);
1097 assert!(text.contains("%4:xmm = x64.movss_rm [$rsp]"), "{text}");
1098 }
1099
1100 /// Every type a parameter can arrive in a register at is one it can be read from memory at.
1101 /// The two lists are keyed off the same two questions so that they cannot drift, and this is
1102 /// what says so: a width one covered and the other did not would be a function turned away for
1103 /// where its arguments happened to land rather than for anything about it.
1104 #[test]
1105 fn the_two_lists_of_widths_answer_for_the_same_types() {
1106 let types = [
1107 Type::int(1),
1108 Type::int(8),
1109 Type::int(16),
1110 Type::int(32),
1111 Type::int(64),
1112 Type::int(128),
1113 Type::PTR,
1114 Type::float(rucc_ir::Float::F32),
1115 Type::float(rucc_ir::Float::F64),
1116 Type::float(rucc_ir::Float::F80),
1117 Type::float(rucc_ir::Float::F128),
1118 ];
1119 for ty in types {
1120 assert_eq!(head_of(ty).is_some(), load_of(ty).is_some(), "{ty:?}");
1121 assert_eq!(head_of(ty).is_some(), store_of(ty).is_some(), "{ty:?}");
1122 assert_eq!(head_of(ty).is_some(), ret_of(ty, 0).is_some(), "{ty:?}");
1123 }
1124 }
1125
1126 /// A hundred and twenty eight bit float arrives in a vector register like the two narrower
1127 /// formats, and it takes one of them rather than two: the psABI classifies it SSE and SSEUP,
1128 /// and what that pair names is the one register both eightbytes are in.
1129 ///
1130 /// The second float here is what says so. If the quad had taken two vector registers the
1131 /// `double` after it would be in `xmm2`.
1132 #[test]
1133 fn a_quad_float_arrives_in_one_vector_register_and_not_in_two() {
1134 let quad = Type::float(rucc_ir::Float::F128);
1135 let f64 = Type::float(rucc_ir::Float::F64);
1136 assert_eq!(
1137 bind(&[quad, f64], &SYSV),
1138 "mfunc @f {\nblock0:\n %0:xmm($xmm0) = x64.arg_val_f128\n \
1139 %1:xmm($xmm1) = x64.arg_val_f64\n}\n"
1140 );
1141 }
1142
1143 /// And it is not the width that was refused before there was an instruction to move it with,
1144 /// which is the one thing about this type that used to turn a whole function away.
1145 #[test]
1146 fn a_quad_float_is_no_longer_a_width_nothing_can_carry() {
1147 assert_eq!(refuses(Type::float(rucc_ir::Float::F128)), None);
1148 assert_eq!(refuses(Type::float(rucc_ir::Float::F80)), Some(Missing::OnX87));
1149 assert_eq!(refuses(Type::int(128)), Some(Missing::Width));
1150 }
1151
1152 /// A float arrives in the other file, and the two files are counted apart on SysV: the
1153 /// integer here is the first integer argument and the float is the first float one, so they
1154 /// are in `rdi` and `xmm0` rather than in the first and second of anything.
1155 #[test]
1156 fn a_float_arrives_in_a_vector_register_and_is_counted_apart_from_the_integers() {
1157 let f32 = Type::float(rucc_ir::Float::F32);
1158 let f64 = Type::float(rucc_ir::Float::F64);
1159 assert_eq!(
1160 bind(&[Type::int(32), f64, f32], &SYSV),
1161 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
1162 %1:xmm($xmm0) = x64.arg_val_f64\n %2:xmm($xmm1) = x64.arg_val_f32\n}\n"
1163 );
1164 }
1165
1166 /// Windows counts the two files together, so the same three arguments land in different
1167 /// registers: the float is the second argument and takes the second vector register rather
1168 /// than the first, which is the difference that makes a mismatched call read the wrong value.
1169 #[test]
1170 fn the_other_convention_counts_the_two_files_as_one_run_of_positions() {
1171 let f64 = Type::float(rucc_ir::Float::F64);
1172 assert_eq!(
1173 bind(&[Type::int(32), f64, Type::int(64)], &WIN64),
1174 "mfunc @f {\nblock0:\n %0:gpr($rcx) = x64.arg_val_32\n \
1175 %1:xmm($xmm1) = x64.arg_val_f64\n %2:gpr($r8) = x64.arg_val_64\n}\n"
1176 );
1177 }
1178
1179 /// A `long double` is in neither file and travels in the argument area, which is what SysV's
1180 /// X87 classification comes to. So it arrives the way a structure the classification put in
1181 /// memory arrives, as the address of its bytes in a general purpose register, and it does that
1182 /// while the vector file is untouched: this one is in the argument area because of what it is
1183 /// rather than because the registers ran out.
1184 #[test]
1185 fn a_long_double_arrives_as_the_address_of_its_bytes_in_the_argument_area() {
1186 let params = [Type::int(32), Type::float(rucc_ir::Float::F80)];
1187 assert_eq!(
1188 bind(¶ms, &SYSV),
1189 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_32\n \
1190 %1:gpr = x64.lea_64 [$rsp]\n}\n"
1191 );
1192 }
1193
1194 /// It still cannot come back beside another value, and what it is turned away for says which
1195 /// file is in the way rather than calling eighty bits a width no register holds. A pair comes
1196 /// back in a pair of registers and there is no pair with the x87 stack in it.
1197 #[test]
1198 fn a_long_double_in_a_pair_is_reported_as_the_x87_stack_it_travels_on() {
1199 let returns = [Type::float(rucc_ir::Float::F80), Type::int(64)];
1200 assert_eq!(
1201 make(&[], &returns, false, &SYSV).2,
1202 Err(Refused { argument: None, missing: Missing::OnX87 })
1203 );
1204 }
1205
1206 /// One call to `g`, with a register for each argument arriving in the block that makes it.
1207 ///
1208 /// A variadic call here names none of its arguments, which is the shape that asks the most of a
1209 /// convention. [`made_naming`] is for the tests that care where the line between the named ones
1210 /// and the rest actually falls.
1211 fn make(
1212 args: &[Type],
1213 returns: &[Type],
1214 variadic: bool,
1215 conv: &CallRegs,
1216 ) -> (Interner, mir::Func, Result<Made, Refused>) {
1217 let named = if variadic { 0 } else { args.len() };
1218 made_naming(args, returns, named, variadic, conv)
1219 }
1220
1221 /// The same, for a callee whose signature names that many of the arguments.
1222 fn made_naming(
1223 args: &[Type],
1224 returns: &[Type],
1225 named: usize,
1226 variadic: bool,
1227 conv: &CallRegs,
1228 ) -> (Interner, mir::Func, Result<Made, Refused>) {
1229 let mut names = Interner::new();
1230 let mut out = mir::Func::new(names.intern("f"));
1231 let block = out.create_block();
1232 let passed: Vec<Passing> = args
1233 .iter()
1234 .map(|&ty| Passing {
1235 ty,
1236 reg: out.append_param(block, class_of(ty, conv)),
1237 abi: Abi::Plain,
1238 })
1239 .collect();
1240 let callee = Callee::Named(names.intern("g"));
1241 let what = Calling { callee, args: &passed, returns, variadic, named };
1242 let made = call(&mut out, block, &what, conv, &mut names);
1243 (names, out, made)
1244 }
1245
1246 /// What the call in that function reads and writes, by register name, in the order the
1247 /// operands are in.
1248 fn operands(func: &mir::Func) -> (Vec<String>, Vec<String>) {
1249 let block = func.entry().expect("a function with a block in it");
1250 let call = func.terminator(block).expect("the call is the last thing in the block");
1251 let name = |operand: &mir::Operand| match (operand.reg.phys(), operand.constraint) {
1252 (Some(reg), _) | (None, Constraint::Fixed(reg)) => {
1253 REGS.name(operand.class, reg).expect("a register the file describes").to_string()
1254 }
1255 _ => format!("{:?}", operand.reg),
1256 };
1257 let mut written = Vec::new();
1258 let mut read = Vec::new();
1259 for operand in &func[func[call].operands] {
1260 let into = if operand.role == mir::Role::Use { &mut read } else { &mut written };
1261 into.push(name(operand));
1262 }
1263 (written, read)
1264 }
1265
1266 #[test]
1267 fn a_call_passes_its_arguments_where_the_convention_puts_them() {
1268 let i32 = Type::int(32);
1269 let (_, func, made) = make(&[i32, i32, i32], &[], false, &SYSV);
1270 assert_eq!(made.expect("three integers all fit in registers").results, []);
1271 assert_eq!(operands(&func).1, ["rdi", "rsi", "rdx"]);
1272 }
1273
1274 #[test]
1275 fn the_other_convention_passes_the_same_arguments_somewhere_else() {
1276 let i64 = Type::int(64);
1277 let (_, func, made) = make(&[i64, i64], &[], false, &WIN64);
1278 // Thirty two bytes of stack for a call that passes nothing on the stack, which is what
1279 // Windows asks a caller to leave the callee whether the callee uses it or not.
1280 assert_eq!(made.expect("two integers fit in registers").outgoing, 32);
1281 assert_eq!(operands(&func).1, ["rcx", "rdx"]);
1282 }
1283
1284 #[test]
1285 fn what_a_call_gives_back_comes_out_of_the_register_the_convention_returns_in() {
1286 let (names, func, made) = make(&[], &[Type::int(32)], false, &SYSV);
1287 let made = made.expect("an integer comes back");
1288 let [result] = made.results[..] else { panic!("one register") };
1289 // The first thing written is the result, and it is the only thing written that is a value
1290 // rather than a register the callee destroyed.
1291 assert_eq!(operands(&func).0.first().map(String::as_str), Some("rax"));
1292 assert_eq!(func.class_of(result), Some(SYSV.int_class));
1293 assert!(mir::print_func(&func, &names, ®S).contains("x64.call"));
1294 }
1295
1296 #[test]
1297 fn every_register_the_callee_may_destroy_is_written_by_the_call() {
1298 let (_, func, _) = make(&[Type::int(64)], &[Type::int(64)], false, &SYSV);
1299 let (written, read) = operands(&func);
1300 // The callee saved registers are not here, because a value in one of those survives a
1301 // call and that is the whole difference between the two halves of the convention.
1302 for saved in ["rbx", "rbp", "r12", "r13", "r14", "r15"] {
1303 assert!(!written.contains(&saved.to_string()), "{saved} survives a call");
1304 }
1305 // Every other integer register is, once. The two named ones are named by the result and
1306 // by the argument instead, and naming one twice would be blocking it twice.
1307 for destroyed in ["rcx", "rdx", "rsi", "r8", "r9", "r10", "r11"] {
1308 let count = written.iter().filter(|name| *name == destroyed).count();
1309 assert_eq!(count, 1, "{destroyed} is destroyed by a call and is written {count} times");
1310 }
1311 assert_eq!(written.iter().filter(|name| *name == "rax").count(), 1);
1312 assert_eq!(read, ["rdi"]);
1313 // The vector registers are all destroyed on SysV, and they are in the other class.
1314 assert!(written.contains(&"xmm0".to_string()));
1315 }
1316
1317 #[test]
1318 fn a_variadic_call_says_how_many_vector_registers_it_passed_arguments_in() {
1319 let (names, func, made) = make(&[Type::int(64)], &[], true, &SYSV);
1320 made.expect("an integer argument to a variadic callee");
1321 let (_, read) = operands(&func);
1322 // Zero of them here, and `al` is where a SysV callee looks for it. Leaving whatever was in
1323 // the register there would make a callee that saves its vector registers save ones it was
1324 // never given.
1325 assert_eq!(read, ["rdi", "rax"]);
1326 assert_eq!(
1327 mir::print_func(&func, &names, ®S).lines().nth(2),
1328 Some(" %1:gpr = x64.mov_ri_32 0")
1329 );
1330
1331 // Two of them here, which is the number that decides how much of the register save area a
1332 // callee like `printf` fills in. A count of zero with a float in `xmm0` would be a callee
1333 // reading its first `%f` out of a register nothing wrote.
1334 let f64 = Type::float(rucc_ir::Float::F64);
1335 let (names, func, made) = make(&[Type::int(64), f64, f64], &[], true, &SYSV);
1336 made.expect("one integer and two floats all fit in registers");
1337 assert_eq!(operands(&func).1, ["rdi", "xmm0", "xmm1", "rax"]);
1338 assert!(mir::print_func(&func, &names, ®S).contains("x64.mov_ri_32 2"));
1339 }
1340
1341 /// Windows passes a float the callee has no prototype for in both files at once, because the
1342 /// callee has no way to know which file to look in and its walk over the arguments reads the
1343 /// general purpose one. This is the whole of what `printf("%f", x)` needs from the caller.
1344 #[test]
1345 fn a_float_a_variadic_callee_has_no_prototype_for_travels_in_both_files_on_windows() {
1346 let f64 = Type::float(rucc_ir::Float::F64);
1347 let (names, func, made) = made_naming(&[Type::int(32), f64], &[], 1, true, &WIN64);
1348 made.expect("an integer and a float both fit in registers");
1349
1350 // The float is the second argument, so its position is one and both of its registers are
1351 // the second of their file. `rdx` holds the bits and nothing converts them, which is what
1352 // the `movq` is: the callee reads bits out of it and not a value of any type.
1353 assert_eq!(operands(&func).1, ["rcx", "xmm1", "rdx"]);
1354 let text = mir::print_func(&func, &names, ®S);
1355 assert!(text.contains("x64.movq_from_xmm %1"), "{text}");
1356 }
1357
1358 /// An argument the signature does name needs no second copy, since the callee's parameter says
1359 /// where it is, and neither does one on a convention that keeps the two files apart.
1360 #[test]
1361 fn an_argument_the_signature_names_travels_in_one_file() {
1362 let f64 = Type::float(rucc_ir::Float::F64);
1363 let (names, func, made) = made_naming(&[Type::int(32), f64], &[], 2, true, &WIN64);
1364 made.expect("both are named");
1365 assert_eq!(operands(&func).1, ["rcx", "xmm1"]);
1366 assert!(!mir::print_func(&func, &names, ®S).contains("movq_from_xmm"));
1367
1368 let (names, func, made) = made_naming(&[Type::int(32), f64], &[], 1, true, &SYSV);
1369 made.expect("an integer and a float");
1370 assert!(!mir::print_func(&func, &names, ®S).contains("movq_from_xmm"));
1371 }
1372
1373 /// A float past the position the registers run out at is in the argument area and nowhere else,
1374 /// which is where the second copy stops being a thing there is room for. The callee reads it
1375 /// out of memory whichever file it would have been in.
1376 #[test]
1377 fn a_float_the_registers_ran_out_before_gets_no_second_copy() {
1378 let f64 = Type::float(rucc_ir::Float::F64);
1379 let (names, func, made) = made_naming(&[f64; 6], &[], 0, true, &WIN64);
1380 made.expect("four in registers and two in memory");
1381 let text = mir::print_func(&func, &names, ®S);
1382 assert_eq!(text.matches("movq_from_xmm").count(), 4, "{text}");
1383 assert!(text.contains("x64.movsd_mr %4, [$rsp + 32]"), "{text}");
1384 }
1385
1386 #[test]
1387 fn a_call_through_an_address_reads_it_in_front_of_the_arguments() {
1388 let i32 = Type::int(32);
1389 let mut names = Interner::new();
1390 let mut out = mir::Func::new(names.intern("f"));
1391 let block = out.create_block();
1392 let address = out.append_param(block, SYSV.int_class);
1393 let reg = out.append_param(block, SYSV.int_class);
1394 let passed = vec![Passing { ty: i32, reg, abi: Abi::Plain }];
1395 let what = Calling {
1396 callee: Callee::Through(address),
1397 args: &passed,
1398 returns: &[i32],
1399 variadic: false,
1400 named: passed.len(),
1401 };
1402 call(&mut out, block, &what, &SYSV, &mut names).expect("one integer fits in a register");
1403
1404 // The address is the first thing read and the arguments follow it, which is the order the
1405 // assembler counts on, and it is in no particular register because every register a call
1406 // could insist on is one the call has already spoken for.
1407 let text = mir::print_func(&out, &names, ®S);
1408 assert!(text.contains("= x64.call_reg %0, %1($rdi)\n"), "{text}");
1409 assert!(!text.contains("@g"), "a call through an address names nobody: {text}");
1410 }
1411
1412 #[test]
1413 fn a_call_with_no_register_left_writes_the_argument_into_the_outgoing_area() {
1414 let i64 = Type::int(64);
1415 let (names, func, made) = make(&[i64; 7], &[], false, &SYSV);
1416 let made = made.expect("the seventh goes to memory");
1417
1418 // At the stack pointer, because the outgoing area is at the bottom of the frame, and in
1419 // front of the call rather than as an operand of it.
1420 let text = mir::print_func(&func, &names, ®S);
1421 assert!(text.contains("x64.mov_mr_64 %6, [$rsp]\n"), "{text}");
1422 let store = text.find("x64.mov_mr_64").expect("the store");
1423 assert!(store < text.find("x64.call").expect("the call"), "{text}");
1424 // One word of it, which is what the frame has to reserve for this call.
1425 assert_eq!(made.outgoing, 8);
1426 }
1427
1428 /// One call to `g`, passing that many words, then an object of that size and alignment by
1429 /// value, then one more integer, which is `int g(long.., struct Big, int)` after the
1430 /// classification.
1431 fn pass_bytes(
1432 before: usize,
1433 size: u64,
1434 align: u32,
1435 conv: &CallRegs,
1436 ) -> (Interner, mir::Func, Result<Made, Refused>) {
1437 let mut names = Interner::new();
1438 let mut out = mir::Func::new(names.intern("f"));
1439 let block = out.create_block();
1440 let mut args: Vec<Passing> = (0..before)
1441 .map(|_| Passing {
1442 ty: Type::int(64),
1443 reg: out.append_param(block, conv.int_class),
1444 abi: Abi::Plain,
1445 })
1446 .collect();
1447 args.push(Passing {
1448 ty: Type::PTR,
1449 reg: out.append_param(block, conv.int_class),
1450 abi: Abi::ByVal { size, align },
1451 });
1452 args.push(Passing {
1453 ty: Type::int(32),
1454 reg: out.append_param(block, conv.int_class),
1455 abi: Abi::Plain,
1456 });
1457 let callee = Callee::Named(names.intern("g"));
1458 let what =
1459 Calling { callee, args: &args, returns: &[], variadic: false, named: args.len() };
1460 let made = call(&mut out, block, &what, conv, &mut names);
1461 (names, out, made)
1462 }
1463
1464 #[test]
1465 fn a_structure_passed_by_value_in_memory_is_copied_into_the_outgoing_area() {
1466 let (names, func, made) = pass_bytes(1, 24, 8, &SYSV);
1467 let made = made.expect("an object of three words is copied a word at a time");
1468
1469 // The bytes travel and the address does not, so the copy is a load and a store for each
1470 // word of it, in front of the call, and the callee's copy is at the bottom of the outgoing
1471 // area. The caller owes it this copy: the callee is free to write to what it was handed,
1472 // so what it was handed cannot be the object itself.
1473 let text = mir::print_func(&func, &names, ®S);
1474 assert!(text.contains("x64.mov_mr_64 %3, [$rsp]\n"), "{text}");
1475 assert!(text.contains("x64.mov_mr_64 %4, [$rsp + 8]\n"), "{text}");
1476 assert!(text.contains("x64.mov_mr_64 %5, [$rsp + 16]\n"), "{text}");
1477 assert_eq!(text.matches("x64.mov_rm_64").count(), 3, "{text}");
1478 assert!(text.find("x64.mov_mr_64") < text.find("x64.call"), "{text}");
1479 assert_eq!(made.outgoing, 24);
1480 }
1481
1482 #[test]
1483 fn the_integers_beside_it_still_travel_in_registers() {
1484 let (_, func, _) = pass_bytes(1, 24, 8, &SYSV);
1485
1486 // An object in the argument area takes no argument register, so the integer behind it is
1487 // in the second one and not the third. Counting it as a register is the mistake that would
1488 // shift every argument after it along by one.
1489 let (clobbered, read) = operands(&func);
1490 assert_eq!(read, ["rdi", "rsi"]);
1491 assert!(clobbered.contains(&"rdx".to_owned()), "the third is free: {clobbered:?}");
1492 }
1493
1494 #[test]
1495 fn an_object_wanting_more_alignment_than_a_word_gets_it() {
1496 let (names, func, made) = pass_bytes(7, 24, 16, &SYSV);
1497 let made = made.expect("an object of three words");
1498
1499 // Six of the integers took the registers and the seventh is at the bottom of the area, so
1500 // the object cannot start where it left off: sixteen byte alignment moves it up to the
1501 // next multiple of sixteen and leaves a word of nothing behind it. The integer after it is
1502 // above all three of its words.
1503 let text = mir::print_func(&func, &names, ®S);
1504 assert!(text.contains("x64.mov_mr_64 %9, [$rsp + 16]\n"), "{text}");
1505 assert!(text.contains("x64.mov_mr_32 %8, [$rsp + 40]\n"), "{text}");
1506 assert_eq!(made.outgoing, 48);
1507 }
1508
1509 #[test]
1510 fn an_object_too_large_to_copy_a_word_at_a_time_is_copied_by_the_runtime() {
1511 let (names, func, made) = pass_bytes(1, 4096, 8, &SYSV);
1512 let made = made.expect("an object the runtime copies");
1513
1514 // Five hundred and twelve words is past what unrolling is worth, so the copy is the call
1515 // the same size of `memcpy` in the IR becomes: the address in the outgoing area, the
1516 // address of the object, and the count, and then the call the object was an argument of.
1517 let text = mir::print_func(&func, &names, ®S);
1518 assert!(text.contains("x64.lea_64 [$rsp]"), "{text}");
1519 assert!(text.contains("x64.mov_ri_32 4096"), "{text}");
1520 assert_eq!(text.matches("x64.call").count(), 2, "the copy and the call: {text}");
1521 assert!(text.find("@memcpy") < text.find("@g"), "the copy comes first: {text}");
1522
1523 // And the argument area is the object, because a call passing three words in registers
1524 // needs none of its own.
1525 assert_eq!(made.outgoing, 4096);
1526 }
1527
1528 #[test]
1529 fn an_object_too_large_to_count_the_bytes_of_is_reported_rather_than_passed() {
1530 let (_, _, made) = pass_bytes(1, 1 << 31, 8, &SYSV);
1531
1532 // Two gigabytes is more than the immediate the byte count travels in holds, and a count
1533 // that does not fit is the whole of what is left to refuse. No program passes a structure
1534 // that size by value, and one that tried would rather hear about it than be handed a copy
1535 // of the low part of it.
1536 assert_eq!(made, Err(Refused { argument: Some(1), missing: Missing::TooBig }));
1537 assert_eq!(
1538 Missing::TooBig.why(),
1539 "is more bytes than a count of them can be written down as"
1540 );
1541 }
1542
1543 /// The other convention runs out three arguments earlier and starts its argument area above the
1544 /// shadow space it also has to reserve, and both of those are what `Places` already said.
1545 #[test]
1546 fn where_the_outgoing_area_starts_is_the_convention_s_answer() {
1547 let i64 = Type::int(64);
1548 let (names, func, made) = make(&[i64; 7], &[], false, &WIN64);
1549 assert_eq!(made.expect("the last three go to memory").outgoing, 56);
1550
1551 // Thirty two bytes of shadow space first, which the caller writes nothing into and the
1552 // callee owns, and the fifth argument above it.
1553 let text = mir::print_func(&func, &names, ®S);
1554 assert!(text.contains("x64.mov_mr_64 %4, [$rsp + 32]\n"), "{text}");
1555 assert!(text.contains("x64.mov_mr_64 %5, [$rsp + 40]\n"), "{text}");
1556 assert!(text.contains("x64.mov_mr_64 %6, [$rsp + 48]\n"), "{text}");
1557 }
1558
1559 /// What a stack argument is written with is its own width and its own register file, matching
1560 /// what the callee reads it back with.
1561 #[test]
1562 fn a_narrow_or_floating_argument_keeps_its_own_store() {
1563 let i64 = Type::int(64);
1564 let narrow = [i64, i64, i64, i64, i64, i64, Type::int(8)];
1565 let (names, func, made) = make(&narrow, &[], false, &SYSV);
1566 made.expect("the seventh goes to memory");
1567 let text = mir::print_func(&func, &names, ®S);
1568 assert!(text.contains("x64.mov_mr_8 %6, [$rsp]\n"), "{text}");
1569
1570 let f32 = Type::float(rucc_ir::Float::F32);
1571 let (names, func, made) = make(&[f32; 9], &[], false, &SYSV);
1572 made.expect("the ninth goes to memory");
1573 let text = mir::print_func(&func, &names, ®S);
1574 assert!(text.contains("x64.movss_mr %8, [$rsp]\n"), "{text}");
1575 }
1576
1577 /// The count a SysV variadic callee reads is a count of registers, so an argument that went to
1578 /// memory instead is not in it.
1579 #[test]
1580 fn an_argument_in_memory_is_not_counted_as_a_vector_register() {
1581 let f64 = Type::float(rucc_ir::Float::F64);
1582 let (names, func, made) = make(&[f64; 9], &[], true, &SYSV);
1583 made.expect("the ninth goes to memory");
1584 let text = mir::print_func(&func, &names, ®S);
1585 assert!(text.contains("x64.mov_ri_32 8\n"), "eight registers, not nine: {text}");
1586 }
1587
1588 /// The two lists of widths answer for the same set of types, so that a value the callee can
1589 /// read out of the argument area is one the caller can write into it.
1590 #[test]
1591 fn what_can_be_read_can_be_written() {
1592 let types = [
1593 Type::int(1),
1594 Type::int(8),
1595 Type::int(16),
1596 Type::int(32),
1597 Type::int(64),
1598 Type::int(128),
1599 Type::PTR,
1600 Type::float(rucc_ir::Float::F32),
1601 Type::float(rucc_ir::Float::F64),
1602 Type::float(rucc_ir::Float::F80),
1603 ];
1604 for ty in types {
1605 assert_eq!(load_of(ty).is_some(), store_of(ty).is_some(), "{ty:?}");
1606 }
1607 }
1608
1609 /// A float travels in the other file at both ends of a call, and the register it comes back in
1610 /// is the first of that file rather than the first of the other one.
1611 #[test]
1612 fn a_call_passes_and_returns_a_float_in_a_vector_register() {
1613 let f64 = Type::float(rucc_ir::Float::F64);
1614 let (_, func, made) = make(&[Type::int(32), f64], &[f64], false, &SYSV);
1615 let result = made.expect("an integer and a float both fit in registers");
1616 let (written, read) = operands(&func);
1617 assert_eq!(read, ["rdi", "xmm0"]);
1618 assert_eq!(written.first().map(String::as_str), Some("xmm0"));
1619 assert_eq!(func.class_of(result.results[0]), Some(SYSV.sse_class));
1620 // Written once, because the register the result comes back in is already blocked by being
1621 // named and a clobber that repeated it would be blocking it twice. `rax` is a clobber here
1622 // rather than the result, which is the same register number in the other file and is the
1623 // whole reason the two lists are counted apart.
1624 assert_eq!(written.iter().filter(|name| *name == "xmm0").count(), 1);
1625 assert!(written.contains(&"rax".to_string()));
1626 }
1627
1628 #[test]
1629 fn a_call_at_a_width_no_register_holds_is_reported_on_either_side() {
1630 let i128 = Type::int(128);
1631 assert_eq!(
1632 make(&[i128], &[], false, &SYSV).2,
1633 Err(Refused { argument: Some(0), missing: Missing::Width })
1634 );
1635 assert_eq!(
1636 make(&[], &[i128], false, &SYSV).2,
1637 Err(Refused { argument: None, missing: Missing::Width })
1638 );
1639 }
1640
1641 #[test]
1642 fn an_argument_wider_than_a_register_has_no_name() {
1643 assert_eq!(head_of(Type::int(128)), None);
1644 assert_eq!(head_of(Type::int(8)), Some("x64.arg_val_8"));
1645 assert_eq!(head_of(Type::int(64)), Some("x64.arg_val_64"));
1646 }
1647
1648 /// An address arrives in a general purpose register like any other integer of its width, and
1649 /// used to be turned away here as a width no register holds, which is what issue 274 is.
1650 /// `int g(char *s)` is the smallest program that was.
1651 #[test]
1652 fn an_address_arrives_in_a_register_like_the_integer_it_is() {
1653 assert_eq!(head_of(Type::PTR), Some("x64.arg_val_64"));
1654 assert_eq!(
1655 bind(&[Type::PTR], &SYSV),
1656 "mfunc @f {\nblock0:\n %0:gpr($rdi) = x64.arg_val_64\n}\n"
1657 );
1658 // And it travels the same way at a call, on both sides of one.
1659 assert!(make(&[Type::PTR], &[Type::PTR], false, &SYSV).2.is_ok());
1660 }
1661}