Skip to main content

rucc_codegen/
wide.rs

1//! The integer that is wider than a register, as the two registers it is held in.
2//!
3//! `__int128` is the one integer a C program on this machine writes that no register holds.
4//! Everything else the front end produces is a width the machine has, or is a width
5//! [`crate::widths`] rounds up into one, and neither of those is true here: there is nothing to
6//! round up into above sixty four bits. What there is, is two registers, and the convention already
7//! says so. System V classifies a `__int128` as two eightbytes of class INTEGER, so it travels in a
8//! pair of general purpose registers, comes back in the pair a return comes back in, and sits in
9//! memory as two words with the low one first. That is what this pass writes down.
10//!
11//! Every value a hundred and twenty eight bits wide becomes two values of sixty four, a low half
12//! and a high half, and every instruction over such a value becomes instructions over the halves.
13//! After it there is no value of that width left anywhere in the function, which is what lets the
14//! rest of the back end stay written about widths the machine has. Nothing below this knows the
15//! type existed.
16//!
17//! # Why a pass and not a rule
18//!
19//! A rule matches a term and rewrites it into instructions of the machine, and the selector works a
20//! value at a time. There is no register a value this wide can be selected into, so there is
21//! nothing for a rule to produce, and a rule that produced a pair would have to say which register
22//! each half landed in, which is the allocator's answer and not a rule's. So the splitting happens
23//! before selection, in the IR, where a value is still something a pass may make two of. That is
24//! the same reasoning [`crate::widths`] follows from the other end, and the two are the two halves
25//! of one sentence: nothing reaching the selector is at a width the machine has no register for.
26//!
27//! # What crosses the boundary
28//!
29//! A parameter and a return value are agreed with something this compilation is not looking at, so
30//! splitting one is a claim about where the two halves are. The claim is true when both halves land
31//! in registers, because the convention hands out argument registers in order and two halves in a
32//! row take the two registers the whole value would have taken. It is not true when they do not: a
33//! value the convention could not fit in registers travels in the argument area as sixteen bytes
34//! aligned to sixteen and leaves the register it could not use to whatever comes after it, and two
35//! independent words in a row would put the first one in that register and the second a word up
36//! from wherever the area had got to.
37//!
38//! So a signature with such a parameter is laid out again rather than split in place. Where every
39//! parameter is meant to be is worked out first, and then the split signature is put in the order
40//! that makes the ordinary walk over it arrive at the same places: the ones in registers first,
41//! then the ones in the argument area by how far up it they are, with a filler that carries nothing
42//! wherever the convention leaves a register or a word empty. Both ends of a call are built from the
43//! same layout, a function's own parameters and every call it makes, so nothing below this has to
44//! know a parameter was ever in any other order, and the IR needs no form of parameter it did not
45//! have.
46//!
47//! A call to a variadic function is laid out the same way over everything it passes, the arguments
48//! past the `...` included, because System V puts each of those where it would have gone had it
49//! been named. What the ABI asks of each of them moves onto the parameter it becomes, so the call
50//! names all its arguments afterwards and still says the callee is variadic, which is what sets the
51//! count of vector registers the callee is told about. A variadic function's own signature with a
52//! wide named parameter that goes in memory is still refused, because its named parameters are what
53//! `va_start` counts from, and so is any of this on a convention that counts the two register files
54//! as one run, where a float past the `...` travels in both. The `va_arg` of one is read in
55//! `rucc-lower` as a pair of words, which is the walk [`crate::varargs`] already has for a small
56//! structure.
57//!
58//! # Dividing and converting are calls into the runtime
59//!
60//! Every other operation at this width is the same operation over the halves with whatever crossed
61//! between them put back. A quotient is not. The halves of a quotient are not a function of the
62//! halves of its operands taken apart, at this width or at any other, which is why every compiler's
63//! runtime has a division routine in it and none of them has an addition one. So a divide and a
64//! remainder become a call to the routines `runtime/builtins/div.c` defines, which are libgcc's four
65//! names and libgcc's signatures, and `spec/12-abi-and-runtime.md` section 12.8 is what they are.
66//!
67//! A conversion to or from a floating point value is the other one, for a plainer reason: the
68//! machine's own conversion reaches sixty four bits and no further, so there is no instruction to
69//! split into. Those are the eight names `runtime/builtins/convert.c` defines, one for each of a
70//! signed and an unsigned integer against a `float` and a `double` in each direction, and the four
71//! `runtime/builtins/quad.c` defines for a `_Float128`, which has no instruction of its own at any
72//! width and so is a call here for both reasons at once. An eighty bit float is not among them,
73//! because this machine has no register that holds one and the back end says so, which is
74//! tamnd/rucc#326, so a function converting at that width is left alone here and refused below the
75//! way every function of this width used to be.
76//!
77//! The call is asked for with the halves already in it, four parameters of sixty four bits for the
78//! two operands of a divide and two results for the answer, or two parameters and a float, or a
79//! float and two results, which is the shape this pass gives a call it found in the program anyway.
80//! Both ends agree because the convention puts a `__int128` argument in two registers in a row and
81//! hands out argument registers in order, which is the same sentence the section below about
82//! crossing the boundary is.
83//!
84//! That is the shape on every convention that has registers for a value this wide and it is not the
85//! shape on Windows x64, where such a value travels as the address of a copy the caller made and an
86//! integer this wide comes back whole in a vector register. The one place the two are told apart is
87//! where the call is built, by asking the ABI the same question a call in the program is asked, so
88//! everything above it goes on describing the call in halves and nothing above it names a target.
89
90use std::collections::{HashMap, HashSet};
91
92use rucc_base::Interner;
93use rucc_ir::{
94    Abi, Block, BlockCall, CallInfo, Def, Extra, Flags, Float, Func, Imm, Inst, InstData, IntPred,
95    MemInfo, MemOrder, Opcode, Param, Restrict, Signature, Type, Value,
96};
97use rucc_target::{AbiDescription, CallRegs, Places, Variadic, Where};
98
99use crate::capability;
100use crate::expand;
101
102/// The width this pass is about, which is the one width a C program writes that no register holds.
103const WIDE: u32 = 128;
104
105/// What the capability table calls that width, which is how the rule language spells one.
106const MODE: &str = "i128";
107
108/// The width each half is, which is a register on every target this pass runs for.
109const HALF: u32 = 64;
110
111/// How many bytes one half takes in memory, which is how far the high one sits above the low one.
112const STEP: u64 = 8;
113
114/// Whether a type is the width this pass splits.
115fn is_wide(ty: Type) -> bool {
116    ty.is_int() && ty.is_scalar() && ty.bits() == WIDE
117}
118
119/// The type each half has.
120fn half() -> Type {
121    Type::int(HALF)
122}
123
124/// Splits every integer the machine holds in two registers into the two halves it holds it in.
125///
126/// Gives back whether it changed anything, which is what a test asks and what tells a reader of a
127/// dump that the function the selector saw is not the one the middle end produced.
128///
129/// The function is left exactly as it was when there is nothing at that width, when something at
130/// that width is reached by an instruction this does not understand, and when a half would cross
131/// the function's boundary somewhere the convention has no register for it. All three leave the
132/// refusal to the passes below, which name the construct they could not lower, rather than
133/// rewriting into something that guessed.
134pub fn halves(func: &mut Func, names: &mut Interner, conv: &CallRegs) -> bool {
135    if !func.values().any(|value| is_wide(func[value].ty)) {
136        return false;
137    }
138    let insts: Vec<Inst> =
139        walk(func).into_iter().flat_map(|block| func.insts(block).collect::<Vec<_>>()).collect();
140    let order: HashMap<Inst, usize> =
141        insts.iter().enumerate().map(|(at, &inst)| (inst, at)).collect();
142    if !insts.iter().enumerate().all(|(at, &inst)| can_split(func, conv, &order, at, inst)) {
143        return false;
144    }
145    let Some(arriving) = plan(func.signature(), conv) else { return false };
146    if !func.signatures().all(|signature| plan(signature, conv).is_some()) {
147        return false;
148    }
149
150    let mut halves: Halves = HashMap::new();
151    let mut forward: HashMap<Value, Value> = HashMap::new();
152    let entry = func.entry();
153    for block in func.blocks().collect::<Vec<_>>() {
154        if Some(block) == entry {
155            arrive(func, block, &arriving, &mut halves, &mut forward);
156        } else {
157            params(func, block, &mut halves, &mut forward);
158        }
159    }
160    for &inst in &insts {
161        rewrite(func, names, conv, &mut halves, &mut forward, inst);
162    }
163    substitute(func, &forward);
164    let signature = planned(func.signature(), &arriving);
165    func.set_signature(signature);
166    true
167}
168
169/// Every block, in an order where a block comes after everything that dominates it.
170///
171/// Reverse postorder from the entry, then whatever the walk did not reach, in the order the
172/// function holds them. The order is what the rule below about a use and its definition is read
173/// against, and the two together are the whole of why this is not simply the order the function
174/// holds the blocks in: a value is defined in a block that dominates every block reading it, a
175/// dominator is on every path from the entry, so a depth first walk finishes it last and reverse
176/// postorder puts it first. The order the function holds blocks in says nothing of the kind. It is
177/// the order they were made in, and every pass in the optimizer that makes a block, which is every
178/// pass that gives a loop a preheader or copies a header in front of one, puts a block that runs
179/// early at the end of that list. So the same program compiled at `-O0` and at `-O1` gave two
180/// different answers to whether this pass understood it, and above `-O0` the answer was often no.
181/// tamnd/rucc#1054.
182///
183/// A block nothing reaches cannot be walked to and is put at the end rather than dropped, because
184/// deciding a block is unreachable is not this pass's business. Two of them in the wrong order
185/// refuse the function the way they always did.
186fn walk(func: &Func) -> Vec<Block> {
187    let Some(entry) = func.entry() else { return func.blocks().collect() };
188    let mut seen: HashSet<Block> = HashSet::new();
189    let mut order: Vec<Block> = Vec::new();
190    // A postorder without recursion: the second time a block comes off the stack every block below
191    // it has been finished, so that is where it belongs in the postorder.
192    let mut stack: Vec<(Block, bool)> = vec![(entry, false)];
193    seen.insert(entry);
194    while let Some((block, done)) = stack.pop() {
195        if done {
196            order.push(block);
197            continue;
198        }
199        stack.push((block, true));
200        let Some(term) = func.terminator(block) else { continue };
201        for call in func.successors(term) {
202            if seen.insert(call.block) {
203                stack.push((call.block, false));
204            }
205        }
206    }
207    order.reverse();
208    order.extend(func.blocks().filter(|block| !seen.contains(block)));
209    order
210}
211
212/// The two halves each wide value became, low first.
213type Halves = HashMap<Value, (Value, Value)>;
214
215/// The opcodes this pass knows how to split.
216///
217/// An instruction that touches a value of this width and is not one of these is why the whole
218/// function is left alone, so this list is the pass's own statement of what it has thought about.
219/// Adding to it is adding an arm to [`rewrite`] as well.
220///
221/// The four divisions and the four conversions to and from a floating point value are here, and they
222/// are the entries that become a call rather than arithmetic over the halves. Which float formats
223/// those conversions are understood at is a separate question, asked in [`can_split`], because it is
224/// about the type rather than about the opcode.
225fn understood(opcode: Opcode) -> bool {
226    matches!(
227        opcode,
228        Opcode::IConst
229            | Opcode::Load
230            | Opcode::Store
231            | Opcode::Add
232            | Opcode::Sub
233            | Opcode::Mul
234            | Opcode::UDiv
235            | Opcode::SDiv
236            | Opcode::URem
237            | Opcode::SRem
238            | Opcode::Shl
239            | Opcode::LShr
240            | Opcode::AShr
241            | Opcode::And
242            | Opcode::Or
243            | Opcode::Xor
244            | Opcode::ICmp
245            | Opcode::Select
246            | Opcode::SIToFP
247            | Opcode::UIToFP
248            | Opcode::FPToSI
249            | Opcode::FPToUI
250            | Opcode::Trunc
251            | Opcode::SExt
252            | Opcode::ZExt
253            | Opcode::Call
254            | Opcode::CallIndirect
255            | Opcode::Return
256            | Opcode::Jump
257            | Opcode::BrIf
258    )
259}
260
261/// Whether one instruction is one this pass can split, given where it is in the walk.
262///
263/// Asked of every instruction, and answered yes at once for the ones that never see a value this
264/// wide, which in a function that has one at all is still most of them.
265fn can_split(
266    func: &Func,
267    conv: &CallRegs,
268    order: &HashMap<Inst, usize>,
269    at: usize,
270    inst: Inst,
271) -> bool {
272    let data = func[inst];
273    let reads = operands(func, inst);
274    let wide = |&value: &Value| is_wide(func[value].ty);
275    if !reads.iter().any(wide) && !data.results().any(|value| is_wide(func[value].ty)) {
276        return true;
277    }
278    if !understood(data.opcode) {
279        return false;
280    }
281    // Memory SSA threads a version of memory through each access, and splitting one access into two
282    // makes a version this pass would have to name. Nothing hands this crate a function carrying it
283    // today, and leaving one alone costs less than being wrong about it later.
284    if func.carries_mem(inst) {
285        return false;
286    }
287    // The machine sign extends from a byte and no narrower, so a truth value widened into the high
288    // half would become an instruction with no rule behind it. Zero extending one is fine, which is
289    // why only the signed side is asked about.
290    if data.opcode == Opcode::SExt && reads.iter().any(|&value| func[value].ty.bits() < 8) {
291        return false;
292    }
293    // The runtime has a conversion for a `float`, for a `double` and for a `_Float128`, and for
294    // nothing else, so every other format is refused here rather than turned into a call to a name
295    // nothing defines. An eighty bit float is the one a program reaches without asking for it, since
296    // `long double` is that type on this target, and it is tamnd/rucc#326 rather than an oversight.
297    if matches!(data.opcode, Opcode::SIToFP | Opcode::UIToFP | Opcode::FPToSI | Opcode::FPToUI)
298        && converted(func, inst).is_none()
299    {
300        return false;
301    }
302    // Splitting an argument makes two of them, and which parameter an argument stands for is how a
303    // variadic call knows what the ABI asks of the ones its signature does not name. So a variadic
304    // call is laid out as a whole, with the arguments past the `...` named as parameters, and that
305    // is only right where naming them changes nothing. On a convention that counts the two files as
306    // one run it does, because a float past the `...` goes in both files and one before it does
307    // not, and on Apple's AArch64 it does too, because everything past the `...` goes in memory.
308    if matches!(data.opcode, Opcode::Call | Opcode::CallIndirect) {
309        let Some((site, variadic)) = site(func, inst) else { return false };
310        let in_memory = conv.abi.variadic == Variadic::AlwaysMemory;
311        if variadic && (conv.shared_positions || in_memory || plan(&site, conv).is_none()) {
312            return false;
313        }
314    }
315    // The halves of a value are written where the value was, so a use this pass reaches before the
316    // definition is a use whose halves do not exist yet. A value arriving as a block parameter is
317    // always ready, since every block's parameters are split before any instruction is.
318    reads.iter().filter(|value| wide(value)).all(|&value| match func[value].def {
319        Def::Result { inst, .. } => order.get(&inst).is_some_and(|&def| def < at),
320        Def::Param { .. } => true,
321    })
322}
323
324/// The format of the floating point side of a conversion, when the runtime has a routine for it.
325///
326/// One float type is in such an instruction, the result of a conversion going up and the operand of
327/// one coming down, so both ends are looked at and the one is found. `None` means the function is
328/// left alone, and it covers a format with no routine, no float at all, and a float on both ends,
329/// which are three shapes that have nothing to be turned into rather than one.
330fn converted(func: &Func, inst: Inst) -> Option<Float> {
331    let data = func[inst];
332    let mut floats = func[data.args]
333        .iter()
334        .copied()
335        .chain(data.results())
336        .map(|value| func[value].ty)
337        .filter(|ty| ty.is_float());
338    let only = floats.next()?;
339    if floats.next().is_some() {
340        return None;
341    }
342    match only.format() {
343        Some(format @ (Float::F32 | Float::F64 | Float::F128)) => Some(format),
344        _ => None,
345    }
346}
347
348/// Everything an instruction reads: its own operands, and the arguments it passes along its edges.
349///
350/// The arguments of a `jump` and of a `br_if` hang on the block call rather than on the
351/// instruction, so an instruction whose own operands are all narrow may still be handing a wide one
352/// to the block it branches to.
353fn operands(func: &Func, inst: Inst) -> Vec<Value> {
354    let mut reads = func[func[inst].args].to_vec();
355    for call in func.successors(inst).collect::<Vec<_>>() {
356        reads.extend_from_slice(&func[call.args]);
357    }
358    reads
359}
360
361/// What one parameter of a split signature is.
362#[derive(Debug, Clone, Copy, PartialEq, Eq)]
363enum Slot {
364    /// The parameter at that index of the whole signature, which is not wide, as it was.
365    Whole(usize),
366    /// The low half of the wide parameter at that index.
367    Low(usize),
368    /// The high half of it.
369    High(usize),
370    /// A value of that type that carries nothing and is there to take a place nothing else takes.
371    Filler(Type),
372}
373
374/// The parameters of one signature once every wide one is two halves, in the order that puts each
375/// of them where the convention puts the whole signature.
376///
377/// The walk is the one [`crate::abi::entry`] and [`crate::abi::call`] make, because the answer has
378/// to be the one that walk will give: it hands out places in the order the signature holds the
379/// parameters. When both halves of every wide parameter land in registers, two halves in a row in
380/// the place of the whole take the two registers the whole value would have taken, and the order
381/// is the order the signature had.
382///
383/// When one does not, System V puts the whole value in the argument area as sixteen bytes aligned
384/// to sixteen and leaves the registers it did not take to the parameters after it. Two words in a
385/// row go somewhere else: the first takes whatever register is left, and a word only has to be
386/// aligned to eight. So the order is built from where everything is meant to be rather than from
387/// the signature. The ones in general purpose registers come first in register order, then the
388/// ones in vector registers, then the ones in the argument area by how far up it they are. A filler
389/// takes a register a wide value skipped, since a word of the argument area is only handed out once
390/// the registers of its kind have run out, and a filler takes each word the alignment of a wide
391/// value leaves empty. The walk is made again over what was built, and anything that did not land
392/// where it was meant to is `None`, as is a variadic signature, whose named parameters have to stay
393/// in front of the rest, and a convention that counts the two register files as one run, which
394/// passes a value this wide some other way.
395///
396/// A return value is not asked about. What comes back comes back in the registers a return uses,
397/// which is a sequence of its own with two in it on this convention, and a signature wanting more
398/// than it has is refused by name in [`crate::lower`] already.
399fn plan(signature: &Signature, conv: &CallRegs) -> Option<Vec<Slot>> {
400    let word = Param::new(half());
401    let mut places = Places::new(conv);
402    let mut meant: Vec<(Slot, Param, Where)> = Vec::new();
403    let mut moved = false;
404    for (index, &param) in signature.params.iter().enumerate() {
405        if !is_wide(param.ty) {
406            meant.push((Slot::Whole(index), param, place(&mut places, param, conv)));
407            continue;
408        }
409        let mut ahead = places.clone();
410        if let (low @ Where::Reg(_), high @ Where::Reg(_)) =
411            (ahead.integer(HALF / 8), ahead.integer(HALF / 8))
412        {
413            places = ahead;
414            meant.push((Slot::Low(index), word, low));
415            meant.push((Slot::High(index), word, high));
416            continue;
417        }
418        let Where::Stack(at) = places.on_stack(WIDE / 8, WIDE / 8) else { return None };
419        meant.push((Slot::Low(index), word, Where::Stack(at)));
420        meant.push((Slot::High(index), word, Where::Stack(at + HALF / 8)));
421        moved = true;
422    }
423    if !moved {
424        return Some(meant.into_iter().map(|(slot, _, _)| slot).collect());
425    }
426    if signature.variadic || conv.shared_positions {
427        return None;
428    }
429
430    let in_reg = |at: &Where| matches!(at, Where::Reg(_));
431    let mut stacked: Vec<&(Slot, Param, Where)> =
432        meant.iter().filter(|(_, _, at)| !in_reg(at)).collect();
433    stacked.sort_by_key(|(_, _, at)| match at {
434        Where::Stack(up) => *up,
435        Where::Reg(_) => 0,
436    });
437    let mut order: Vec<(Slot, Param, Option<Where>)> = Vec::new();
438    for float in [false, true] {
439        let kind = |param: &Param| scalar(*param) && param.ty.is_float() == float;
440        order.extend(
441            meant
442                .iter()
443                .filter(|(_, param, at)| kind(param) && in_reg(at))
444                .map(|&(slot, param, at)| (slot, param, Some(at))),
445        );
446        let (count, filler) = match float {
447            false => (conv.int_args.len(), word),
448            true => (conv.sse_args.len(), Param::new(Type::float(Float::F64))),
449        };
450        if stacked.iter().any(|(_, param, _)| kind(param)) {
451            let took = order.iter().filter(|(_, param, _)| kind(param)).count();
452            let padding = count.saturating_sub(took);
453            order.extend((0..padding).map(|_| (Slot::Filler(filler.ty), filler, None)));
454        }
455    }
456
457    let mut places = Places::new(conv);
458    let mut slots = Vec::with_capacity(order.len() + stacked.len());
459    for (slot, param, meant) in order {
460        let at = place(&mut places, param, conv);
461        if !in_reg(&at) || meant.is_some_and(|meant| meant != at) {
462            return None;
463        }
464        slots.push(slot);
465    }
466    for &&(slot, param, meant) in &stacked {
467        let Where::Stack(up) = meant else { return None };
468        while places.size() < up {
469            if in_reg(&place(&mut places, word, conv)) {
470                return None;
471            }
472            slots.push(Slot::Filler(word.ty));
473        }
474        if place(&mut places, param, conv) != meant {
475            return None;
476        }
477        slots.push(slot);
478    }
479    Some(slots)
480}
481
482/// Where the next parameter goes, asked the way [`crate::abi::entry`] asks.
483fn place(places: &mut Places<'_>, param: Param, conv: &CallRegs) -> Where {
484    // A structure the classification put in the argument area, which is the one parameter whose
485    // place is bytes rather than a register. Everything else is a value, the pointer an `sret`
486    // hands over included, and a value takes the next register of its own kind.
487    if let Abi::ByVal { size, align, drains } = param.abi {
488        let at = places.object(u32::try_from(size).unwrap_or(u32::MAX), align);
489        crate::abi::drain(places, drains);
490        at
491    } else if crate::abi::on_the_stack(param.ty) {
492        let (size, align) = crate::abi::X87_AREA;
493        places.on_stack(size, align)
494    } else if param.ty.is_float() {
495        places.float(crate::abi::float_bytes(param.ty))
496    } else {
497        places.integer(crate::abi::int_bytes(param.ty, conv))
498    }
499}
500
501/// Whether a parameter is a value that takes a register of its kind while there is one left.
502fn scalar(param: Param) -> bool {
503    !matches!(param.abi, Abi::ByVal { .. }) && !crate::abi::on_the_stack(param.ty)
504}
505
506/// A signature laid out the way [`plan`] said, with every wide return value as two halves.
507fn planned(signature: &Signature, slots: &[Slot]) -> Signature {
508    let params = slots
509        .iter()
510        .map(|&slot| match slot {
511            Slot::Whole(index) => signature.params[index],
512            Slot::Low(_) | Slot::High(_) => Param::new(half()),
513            Slot::Filler(ty) => Param::new(ty),
514        })
515        .collect();
516    Signature { params, ..split_signature(signature) }
517}
518
519/// One block's parameters, with each wide one replaced by its two halves in the same position.
520///
521/// Every parameter of such a block is made again rather than only the wide ones, because a
522/// parameter's position is its identity to the branches that feed it and appending is the only way
523/// to add one. The narrow ones are made again as themselves and pointed at the copy, which costs
524/// nothing once the substitution below has run.
525fn params(func: &mut Func, block: Block, halves: &mut Halves, forward: &mut HashMap<Value, Value>) {
526    let old: Vec<Value> = func[block].params.clone();
527    if !old.iter().any(|&value| is_wide(func[value].ty)) {
528        return;
529    }
530    for &value in &old {
531        if is_wide(func[value].ty) {
532            let low = func.append_param(block, half());
533            let high = func.append_param(block, half());
534            halves.insert(value, (low, high));
535        } else {
536            let again = func.append_param(block, func[value].ty);
537            forward.insert(value, again);
538        }
539    }
540    func.retain_params(block, |value| !old.contains(&value));
541}
542
543/// The entry block's parameters, laid out the way [`plan`] said the function's own are.
544fn arrive(
545    func: &mut Func,
546    block: Block,
547    slots: &[Slot],
548    halves: &mut Halves,
549    forward: &mut HashMap<Value, Value>,
550) {
551    let old: Vec<Value> = func[block].params.clone();
552    if !old.iter().any(|&value| is_wide(func[value].ty)) {
553        return;
554    }
555    let mut lows = HashMap::new();
556    for &slot in slots {
557        match slot {
558            Slot::Whole(index) => {
559                let again = func.append_param(block, func[old[index]].ty);
560                forward.insert(old[index], again);
561            }
562            Slot::Low(index) => {
563                lows.insert(index, func.append_param(block, half()));
564            }
565            Slot::High(index) => {
566                let high = func.append_param(block, half());
567                halves.insert(old[index], (lows[&index], high));
568            }
569            Slot::Filler(ty) => {
570                func.append_param(block, ty);
571            }
572        }
573    }
574    func.retain_params(block, |value| !old.contains(&value));
575}
576
577/// One instruction, as instructions over halves.
578fn rewrite(
579    func: &mut Func,
580    names: &mut Interner,
581    conv: &CallRegs,
582    halves: &mut Halves,
583    forward: &mut HashMap<Value, Value>,
584    inst: Inst,
585) {
586    let abi = conv.abi;
587    let data = func[inst];
588    let produces = data.results().any(|value| is_wide(func[value].ty));
589    let takes = func[data.args].iter().any(|&value| is_wide(func[value].ty));
590    match data.opcode {
591        Opcode::IConst if produces => constant(func, halves, inst),
592        Opcode::Load if produces => load(func, halves, inst),
593        Opcode::Store if takes => store(func, halves, inst),
594        Opcode::Add | Opcode::Sub if produces => carried(func, halves, inst, data.opcode),
595        Opcode::Mul if produces => multiply(func, halves, inst),
596        Opcode::UDiv | Opcode::SDiv | Opcode::URem | Opcode::SRem if produces => {
597            divide(func, names, abi, halves, inst, data.opcode);
598        }
599        Opcode::Shl | Opcode::LShr | Opcode::AShr if produces => {
600            shifted(func, halves, inst, data.opcode);
601        }
602        Opcode::And | Opcode::Or | Opcode::Xor if produces => {
603            bitwise(func, halves, inst, data.opcode);
604        }
605        Opcode::SIToFP | Opcode::UIToFP if takes => {
606            to_float(func, names, abi, halves, forward, inst, data.opcode == Opcode::SIToFP);
607        }
608        Opcode::FPToSI | Opcode::FPToUI if produces => {
609            from_float(func, names, abi, halves, inst, data.opcode == Opcode::FPToSI);
610        }
611        Opcode::ICmp if takes => compare(func, halves, forward, inst),
612        Opcode::Select if produces => choose(func, halves, inst),
613        Opcode::Trunc if takes => truncate(func, halves, forward, inst),
614        Opcode::SExt | Opcode::ZExt if produces => {
615            extend(func, halves, inst, data.opcode == Opcode::SExt);
616        }
617        Opcode::Call | Opcode::CallIndirect if produces || takes => {
618            call(func, conv, halves, forward, inst);
619        }
620        Opcode::Return if takes => flatten(func, halves, inst),
621        Opcode::Jump | Opcode::BrIf => edges(func, halves, inst),
622        _ => {}
623    }
624}
625
626/// A constant, as the two halves of its bits with the low one first.
627fn constant(func: &mut Func, halves: &mut Halves, inst: Inst) {
628    let Extra::Imm(imm) = func[inst].extra else { return };
629    let bits = func[imm].unsigned();
630    #[expect(clippy::cast_possible_truncation, reason = "the halves are what this is taking")]
631    let (low, high) = (bits as u64, (bits >> HALF) as u64);
632    let low = ahead_const(func, inst, i128::from(low));
633    let high = ahead_const(func, inst, i128::from(high));
634    replace(func, halves, inst, low, high);
635}
636
637/// A read, as the two words of it with the low one first.
638///
639/// Little endian is the order, which is what every target this back end has is. The high word knows
640/// less about its alignment than the low one when the low one knew more than a word, since a
641/// sixteen byte object aligned to sixteen has its high word aligned to eight.
642fn load(func: &mut Func, halves: &mut Halves, inst: Inst) {
643    let data = func[inst];
644    let Extra::Mem(mem) = data.extra else { return };
645    let info = func[mem];
646    let Some(&from) = func[data.args].first() else { return };
647    let low = read(func, inst, from, word(info, 0), data.flags);
648    let up = stepped(func, inst, from);
649    let high = read(func, inst, up, word(info, STEP), data.flags);
650    replace(func, halves, inst, low, high);
651}
652
653/// A write, as the two words of it.
654fn store(func: &mut Func, halves: &mut Halves, inst: Inst) {
655    let data = func[inst];
656    let Extra::Mem(mem) = data.extra else { return };
657    let info = func[mem];
658    let args = func[data.args].to_vec();
659    let [value, into] = args[..] else { return };
660    let Some(&(low, high)) = halves.get(&value) else { return };
661    write(func, inst, low, into, word(info, 0), data.flags);
662    let up = stepped(func, inst, into);
663    write(func, inst, high, up, word(info, STEP), data.flags);
664    func.remove_inst(inst);
665}
666
667/// An add or a subtract, as the same over the low halves and the same again over the high ones with
668/// what the low halves carried between them.
669///
670/// The carry is a comparison and not a flag. An unsigned sum comes out below either operand exactly
671/// when it wrapped, and an unsigned difference wrapped exactly when the left operand was below the
672/// right, which are the two tests [`crate::expand`] writes for the overflow builtins and are what
673/// the machine's own carry flag stands for. Whether the pair is put back together into an `adc` and
674/// an `sbb` is a question for what reads flags rather than for this, and the answer here is correct
675/// either way.
676fn carried(func: &mut Func, halves: &mut Halves, inst: Inst, opcode: Opcode) {
677    let args = func[func[inst].args].to_vec();
678    let [a, b] = args[..] else { return };
679    let (Some(&(a_low, a_high)), Some(&(b_low, b_high))) = (halves.get(&a), halves.get(&b)) else {
680        return;
681    };
682    let low = ahead(func, inst, opcode, &[a_low, b_low]);
683    let carried = if opcode == Opcode::Add {
684        compared(func, inst, IntPred::Ult, low, a_low)
685    } else {
686        compared(func, inst, IntPred::Ult, a_low, b_low)
687    };
688    let carry = ahead(func, inst, Opcode::ZExt, &[carried]);
689    let high = ahead(func, inst, opcode, &[a_high, b_high]);
690    let high = ahead(func, inst, opcode, &[high, carry]);
691    replace(func, halves, inst, low, high);
692}
693
694/// A multiply, which is long multiplication in base two to the sixty fourth with everything that
695/// lands above the width thrown away.
696///
697/// The low half of the answer is the low halves multiplied together. The high half is what that
698/// multiply carried out of its own top, plus the two cross products, each of which starts at bit
699/// sixty four. The fourth partial product is the two high halves against each other and it starts
700/// at bit one hundred and twenty eight, so the whole of it is above the width and it is never
701/// worked out, which is why a wide multiply is three multiplies and not four.
702///
703/// Nothing here asks whether the operands are signed, because the low hundred and twenty eight bits
704/// of a product are the same bits either way. The sign only matters to the bits that are being
705/// thrown away.
706///
707/// The carry out of the low halves is the high half of a sixty four bit product, which this machine
708/// has an instruction for and this compiler has no way to ask for. [`crate::expand`] already writes
709/// that out as long multiplication one level further down, for the overflow builtins, so this calls
710/// it rather than keeping a second copy of the same arithmetic. It is the expensive part of a wide
711/// multiply by a long way, and `tamnd/rucc#309` is the rule that would make it one instruction for
712/// both callers at once.
713fn multiply(func: &mut Func, halves: &mut Halves, inst: Inst) {
714    let args = func[func[inst].args].to_vec();
715    let [a, b] = args[..] else { return };
716    let (Some(&(a_low, a_high)), Some(&(b_low, b_high))) = (halves.get(&a), halves.get(&b)) else {
717        return;
718    };
719    let low = ahead(func, inst, Opcode::Mul, &[a_low, b_low]);
720    let carried = expand::high_half(func, inst, a_low, b_low, false, half());
721    let cross = ahead(func, inst, Opcode::Mul, &[a_low, b_high]);
722    let other = ahead(func, inst, Opcode::Mul, &[a_high, b_low]);
723    let high = ahead(func, inst, Opcode::Add, &[carried, cross]);
724    let high = ahead(func, inst, Opcode::Add, &[high, other]);
725    replace(func, halves, inst, low, high);
726}
727
728/// A divide or a remainder, as a call to the routine in the compiler runtime that works it out.
729///
730/// The four names are libgcc's, and the archive `runtime/builtins/div.c` builds into defines them for
731/// a target that has no libgcc, which is every target this compiler links without gcc's driver. What
732/// picks one of the four is the opcode and nothing else: the sign is in the name because it is in the
733/// answer, since a quotient rounds towards zero and a remainder takes the sign of the dividend, and
734/// neither is the unsigned answer with bits reinterpreted the way a sum is.
735///
736/// The call is created with the halves in it rather than with the wide values, which would then be
737/// split by [`call`] on the next instruction of the walk. Four parameters and two results, in the
738/// order the operands were in and low half first, because that is where the convention puts the two
739/// eightbytes of a value this wide and [`split_signature`] is what the routine's own definition went
740/// through on the way in.
741///
742/// Nothing here is conditional on the divisor. Dividing by zero is undefined in C, the machine traps
743/// on it at every width it has, and a test written in front of the call would be this pass deciding
744/// what an undefined program does.
745fn divide(
746    func: &mut Func,
747    names: &mut Interner,
748    abi: &'static AbiDescription,
749    halves: &mut Halves,
750    inst: Inst,
751    opcode: Opcode,
752) {
753    let args = func[func[inst].args].to_vec();
754    let [a, b] = args[..] else { return };
755    let (Some(&(a_low, a_high)), Some(&(b_low, b_high))) = (halves.get(&a), halves.get(&b)) else {
756        return;
757    };
758    // The four that need the whole value at once, which is why they are calls rather than a pair
759    // of half width instructions like everything else in this pass. Which call each one is, is in
760    // the capability table, since a routine name is a fact about what this target cannot do.
761    let Some(routine) = capability::libcall(opcode, MODE) else { return };
762    let args = [Operand::Split(a_low, a_high), Operand::Split(b_low, b_high)];
763    let made = runtime(func, names, abi, inst, routine, &args, &[half(), half()]);
764    let [low, high] = made[..] else { return };
765    replace(func, halves, inst, low, high);
766}
767
768/// A conversion from one of these to a float, as a call to the routine that works it out.
769///
770/// Two parameters of sixty four bits and one float result. The answer is not a wide value, so the
771/// instruction's own result is pointed at the call's rather than halved, which is what [`compare`]
772/// and [`truncate`] do with a narrow answer as well.
773///
774/// The sign is in the name because it is in the answer: the same hundred and twenty eight bits are
775/// two different numbers depending on it, and unlike a sum the float they become is two different
776/// floats.
777fn to_float(
778    func: &mut Func,
779    names: &mut Interner,
780    abi: &'static AbiDescription,
781    halves: &Halves,
782    forward: &mut HashMap<Value, Value>,
783    inst: Inst,
784    signed: bool,
785) {
786    let Some(&arg) = func[func[inst].args].first() else { return };
787    let Some(&(low, high)) = halves.get(&arg) else { return };
788    let (Some(result), Some(format)) = (func[inst].first_result, converted(func, inst)) else {
789        return;
790    };
791    let routine = going_up(signed, format);
792    let args = [Operand::Split(low, high)];
793    let made = runtime(func, names, abi, inst, routine, &args, &[func[result].ty]);
794    if let [answer] = made[..] {
795        forward.insert(result, answer);
796    }
797    func.remove_inst(inst);
798}
799
800/// A conversion from a float to one of these, as a call to the routine that works it out.
801///
802/// One float parameter and two results of sixty four bits, which is the divide's shape with the
803/// operands and the answer the other way round. The operand is a float and so was never split, and
804/// it is passed along as it is.
805///
806/// A value the integer cannot hold, an infinity and a not a number are all undefined in C, and
807/// nothing is written in front of the call about any of them, for the reason [`divide`] writes
808/// nothing in front of itself about a zero divisor.
809fn from_float(
810    func: &mut Func,
811    names: &mut Interner,
812    abi: &'static AbiDescription,
813    halves: &mut Halves,
814    inst: Inst,
815    signed: bool,
816) {
817    let Some(&arg) = func[func[inst].args].first() else { return };
818    let Some(format) = converted(func, inst) else { return };
819    let routine = coming_down(signed, format);
820    let args = [Operand::Whole(arg)];
821    let made = runtime(func, names, abi, inst, routine, &args, &[half(), half()]);
822    let [low, high] = made[..] else { return };
823    replace(func, halves, inst, low, high);
824}
825
826/// The routine that turns an integer this wide into a float of that format.
827///
828/// Three formats, since [`converted`] answers with no others, and the quad is the last arm rather
829/// than a named one so that a format added to that list arrives here as a routine that does not
830/// exist rather than as a name that is wrong.
831fn going_up(signed: bool, format: Float) -> &'static str {
832    let mode = match format {
833        Float::F32 => "i128.f32",
834        Float::F64 => "i128.f64",
835        _ => "i128.f128",
836    };
837    routine(if signed { Opcode::SIToFP } else { Opcode::UIToFP }, mode)
838}
839
840/// The routine that turns a float of that format into an integer this wide.
841fn coming_down(signed: bool, format: Float) -> &'static str {
842    let mode = match format {
843        Float::F32 => "f32.i128",
844        Float::F64 => "f64.i128",
845        _ => "f128.i128",
846    };
847    routine(if signed { Opcode::FPToSI } else { Opcode::FPToUI }, mode)
848}
849
850/// The routine the capability table names for this operation at this width.
851///
852/// Every mode this pass asks about is one this machine has no register wide enough for, so the
853/// table always has an answer and a missing one is the table and this pass having gone out of step.
854fn routine(opcode: Opcode, mode: &str) -> &'static str {
855    capability::libcall(opcode, mode)
856        .unwrap_or_else(|| panic!("no routine for `{}` at `{mode}`", opcode.name()))
857}
858
859/// One operand of a call to a runtime routine, as this pass has it in hand.
860///
861/// A wide integer is two halves here because two halves is what this pass has turned every one of
862/// them into, and whether the routine is handed the two of them or the address of the one value
863/// they are is the convention's answer rather than this pass's.
864#[derive(Clone, Copy)]
865enum Operand {
866    /// A value of a type the machine holds, given as itself.
867    Whole(Value),
868    /// A wide integer, given as the low half and the high half it became.
869    Split(Value, Value),
870}
871
872/// A call to a routine in the compiler runtime, written in front of an instruction, with the values
873/// it answers.
874///
875/// Where the convention hands everything over in registers the signature is made out of the types
876/// of the values being handed over, because the values are already the halves at this point and the
877/// routine's own definition went through [`split_signature`] on the way in, so the two descriptions
878/// are the same one arrived at from the two ends.
879///
880/// Windows x64 does not hand a value of this width over in registers. A scalar of a size no register
881/// holds travels as the address of a copy the caller made, which is the rule `tamnd/rucc#1331` put
882/// in the ABI description, and it applies to a call this pass writes exactly as it applies to a call
883/// the program wrote: libgcc's `__floattitf` on that target reads its `__int128` out of the address
884/// in `rdx` and writes its answer through the address in `rcx`. So an operand the convention passes
885/// by address becomes a frame slot with a copy of the value in it, a slot per operand because a
886/// routine may write through an address it was handed, and a single answer that comes back by
887/// address becomes a slot passed as the leading `sret` argument with the load out of it standing for
888/// the call's result.
889///
890/// An answer at this width is the third shape and the one that reads strangely. mingw brings a
891/// sixteen byte integer back in `xmm0` rather than through an address, which is gcc's answer to a
892/// convention that has no integer that size in it, so the call is written as returning one value at
893/// the quad float format and the two halves are read back out of a slot it is stored into. The
894/// format is a name for sixteen bytes in a vector register and says nothing about what is in them,
895/// which is the same thing the routine's own `movaps` says.
896fn runtime(
897    func: &mut Func,
898    names: &mut Interner,
899    abi: &'static AbiDescription,
900    inst: Inst,
901    routine: &str,
902    args: &[Operand],
903    results: &[Type],
904) -> Vec<Value> {
905    let mut params: Vec<Param> = Vec::new();
906    let mut values: Vec<Value> = Vec::new();
907    let mut answer = Answer::Registers;
908    // The answer first, because an address it comes back through is the first argument.
909    match *results {
910        [ty] if abi.scalar_is_by_reference(bytes(ty)) => {
911            let size = bytes(ty);
912            let align = align(size);
913            let slot = room(func, inst, size, align);
914            params.push(Param::with_abi(Type::PTR, Abi::Sret { size, align }));
915            values.push(slot);
916            answer = Answer::Slot(slot, ty);
917        }
918        [low, high] if low == half() && high == half() => {
919            if let Some(format) = packed(abi) {
920                answer = Answer::Packed(format);
921            }
922        }
923        _ => {}
924    }
925    for &arg in args {
926        handed(func, abi, inst, arg, &mut params, &mut values);
927    }
928    let answers = match answer {
929        Answer::Registers => results.to_vec(),
930        Answer::Slot(..) => Vec::new(),
931        Answer::Packed(format) => vec![Type::float(format)],
932    };
933    let returns = answers.iter().map(|&ty| Param::new(ty)).collect();
934    let signature = func.add_signature(Signature { params, returns, variadic: false });
935    let callee = Some(names.intern(routine));
936    let varargs = func.push_abis(&[]);
937    let extra = Extra::Call(func.add_call(CallInfo { callee, signature, varargs }));
938    let pushed = func.push_values(&values);
939    let span = func.span(inst);
940    let data = InstData { args: pushed, extra, ..InstData::new(Opcode::Call) };
941    let made = func.create_inst(data, &answers, span);
942    func.insert_before(made, inst);
943    match answer {
944        Answer::Registers => func[made].results().collect(),
945        Answer::Slot(slot, ty) => {
946            let size = bytes(ty);
947            let info = whole(size, align(size));
948            let extra = Extra::Mem(func.add_mem(info));
949            let args = func.push_values(&[slot]);
950            let data = InstData { args, extra, ..InstData::new(Opcode::Load) };
951            vec![written(func, inst, data, ty)]
952        }
953        Answer::Packed(format) => unpacked(func, inst, made, format),
954    }
955}
956
957/// Where the answer of such a call is, once the convention has been asked about it.
958#[derive(Clone, Copy)]
959enum Answer {
960    /// In the registers the signature's own result types name, which is every convention that has
961    /// registers for a value of the width being asked about.
962    Registers,
963    /// In a frame slot whose address went over as the leading `sret` argument, with the type the
964    /// call was meant to answer with.
965    Slot(Value, Type),
966    /// Whole in a vector register, at a format that is this many bytes and is not what is in them.
967    Packed(Float),
968}
969
970/// The format a wide integer answer comes back in on this convention, where it comes back in a
971/// register at all, as the IR spells a format.
972///
973/// [`None`] everywhere but Windows x64. The question is asked of the ABI rather than of the target
974/// name for the reason the rest of this pass asks it there: a second list of which targets do this
975/// is a list that can disagree with the one the classifier reads.
976fn packed(abi: &'static AbiDescription) -> Option<Float> {
977    let format = abi.wide_integer_returns_in(u64::from(WIDE / 8))?;
978    Float::from_bits(format.width())
979}
980
981/// The two halves of an answer that came back whole in a register, read out of a slot it is stored
982/// into.
983///
984/// A store and two loads rather than anything cleverer because the value in hand is at a float
985/// format and the halves wanted are integers, and the frame is the only place this compiler moves
986/// bits between the two files without saying something about them. It is what gcc writes for the
987/// same call.
988fn unpacked(func: &mut Func, inst: Inst, call: Inst, format: Float) -> Vec<Value> {
989    let Some(value) = func[call].first_result else { return Vec::new() };
990    let size = bytes(Type::float(format));
991    let align = align(size);
992    let slot = room(func, inst, size, align);
993    let info = whole(size, align);
994    write(func, inst, value, slot, info, Flags::NONE);
995    let low = read(func, inst, slot, word(info, 0), Flags::NONE);
996    let up = stepped(func, inst, slot);
997    let high = read(func, inst, up, word(info, STEP), Flags::NONE);
998    vec![low, high]
999}
1000
1001/// One operand of such a call, in the form the convention hands it over in.
1002fn handed(
1003    func: &mut Func,
1004    abi: &'static AbiDescription,
1005    inst: Inst,
1006    arg: Operand,
1007    params: &mut Vec<Param>,
1008    values: &mut Vec<Value>,
1009) {
1010    match arg {
1011        Operand::Whole(value) => {
1012            let ty = func[value].ty;
1013            let size = bytes(ty);
1014            if !abi.scalar_is_by_reference(size) {
1015                params.push(Param::new(ty));
1016                values.push(value);
1017                return;
1018            }
1019            let align = align(size);
1020            let slot = room(func, inst, size, align);
1021            write(func, inst, value, slot, whole(size, align), Flags::NONE);
1022            params.push(Param::new(Type::PTR));
1023            values.push(slot);
1024        }
1025        Operand::Split(low, high) => {
1026            let size = u64::from(WIDE / 8);
1027            if !abi.scalar_is_by_reference(size) {
1028                params.push(Param::new(half()));
1029                values.push(low);
1030                params.push(Param::new(half()));
1031                values.push(high);
1032                return;
1033            }
1034            let align = align(size);
1035            let slot = room(func, inst, size, align);
1036            let info = whole(size, align);
1037            write(func, inst, low, slot, word(info, 0), Flags::NONE);
1038            let up = stepped(func, inst, slot);
1039            write(func, inst, high, up, word(info, STEP), Flags::NONE);
1040            params.push(Param::new(Type::PTR));
1041            values.push(slot);
1042        }
1043    }
1044}
1045
1046/// How many bytes a value of this type takes.
1047fn bytes(ty: Type) -> u64 {
1048    u64::from(ty.bits().div_ceil(8))
1049}
1050
1051/// How far a value of that size is aligned, which at these sizes is the size itself.
1052fn align(size: u64) -> u32 {
1053    u32::try_from(size).unwrap_or(u32::MAX)
1054}
1055
1056/// An ordinary access of the whole of one value of that size.
1057fn whole(size: u64, align: u32) -> MemInfo {
1058    MemInfo {
1059        size,
1060        align,
1061        order: MemOrder::NotAtomic,
1062        tbaa: None,
1063        owns: 0,
1064        restrict: Restrict::NONE,
1065    }
1066}
1067
1068/// A frame slot of that size, written in front of an instruction.
1069fn room(func: &mut Func, inst: Inst, size: u64, align: u32) -> Value {
1070    let extra = Extra::Mem(func.add_mem(whole(size, align)));
1071    written(func, inst, InstData { extra, ..InstData::new(Opcode::Alloca) }, Type::PTR)
1072}
1073
1074/// A shift, as each half shifted by the count with the bits that crossed between them put back, and
1075/// a second answer for a count that reached a whole half.
1076///
1077/// A count below sixty four moves each half by the count, and the bits that left one half are the
1078/// ones that arrive in the other. A count of sixty four or more empties one half completely, and
1079/// what lands in the other is the first half moved by the count less sixty four. Taking the sixty
1080/// four bit off a count in range is the same as subtracting sixty four from it, so both cases shift
1081/// by the same number of places and differ only in which value ends up where, which means one shift
1082/// each and a choice rather than two of everything. The choice is a `select` and not a branch, for
1083/// the reason [`choose`] gives.
1084///
1085/// The bits that cross move the other way by sixty four less the count. That is a shift of sixty
1086/// four places when the count is zero, which is not a distance this width has. Moving one place and
1087/// then sixty three less the count is the same distance for every count from one to sixty three,
1088/// and for a count of zero it shifts a value whose top bit is already gone all the way down to
1089/// nothing, which is the right answer: a half that did not move carries nothing into the other one.
1090///
1091/// A count of a hundred and twenty eight or more is undefined in C and nothing here goes out of its
1092/// way about it, the same as at every other width.
1093fn shifted(func: &mut Func, halves: &mut Halves, inst: Inst, opcode: Opcode) {
1094    let args = func[func[inst].args].to_vec();
1095    let [a, b] = args[..] else { return };
1096    let (Some(&(a_low, a_high)), Some(&(count, _))) = (halves.get(&a), halves.get(&b)) else {
1097        return;
1098    };
1099    let top = ahead_const(func, inst, i128::from(HALF - 1));
1100    let places = ahead(func, inst, Opcode::And, &[count, top]);
1101    let back = ahead(func, inst, Opcode::Sub, &[top, places]);
1102    let one = ahead_const(func, inst, 1);
1103    let zero = ahead_const(func, inst, 0);
1104    let bit = ahead_const(func, inst, i128::from(HALF));
1105    let reach = ahead(func, inst, Opcode::And, &[count, bit]);
1106    let whole = compared(func, inst, IntPred::Ne, reach, zero);
1107
1108    let (low, high) = if opcode == Opcode::Shl {
1109        let moved = ahead(func, inst, Opcode::Shl, &[a_low, places]);
1110        let edge = ahead(func, inst, Opcode::LShr, &[a_low, one]);
1111        let across = ahead(func, inst, Opcode::LShr, &[edge, back]);
1112        let above = ahead(func, inst, Opcode::Shl, &[a_high, places]);
1113        let joined = ahead(func, inst, Opcode::Or, &[above, across]);
1114        let low = ahead(func, inst, Opcode::Select, &[whole, zero, moved]);
1115        let high = ahead(func, inst, Opcode::Select, &[whole, moved, joined]);
1116        (low, high)
1117    } else {
1118        let moved = ahead(func, inst, opcode, &[a_high, places]);
1119        let edge = ahead(func, inst, Opcode::Shl, &[a_high, one]);
1120        let across = ahead(func, inst, Opcode::Shl, &[edge, back]);
1121        let below = ahead(func, inst, Opcode::LShr, &[a_low, places]);
1122        let joined = ahead(func, inst, Opcode::Or, &[below, across]);
1123        // What is left behind when the whole low half is gone: zeroes for a logical shift, and for
1124        // an arithmetic one the sign bit spread over the half it came from.
1125        let spent = if opcode == Opcode::AShr {
1126            ahead(func, inst, Opcode::AShr, &[a_high, top])
1127        } else {
1128            zero
1129        };
1130        let low = ahead(func, inst, Opcode::Select, &[whole, moved, joined]);
1131        let high = ahead(func, inst, Opcode::Select, &[whole, spent, moved]);
1132        (low, high)
1133    };
1134    replace(func, halves, inst, low, high);
1135}
1136
1137/// An `and`, an `or` or an `xor`, which is the same operation on each half and nothing between
1138/// them.
1139fn bitwise(func: &mut Func, halves: &mut Halves, inst: Inst, opcode: Opcode) {
1140    let args = func[func[inst].args].to_vec();
1141    let [a, b] = args[..] else { return };
1142    let (Some(&(a_low, a_high)), Some(&(b_low, b_high))) = (halves.get(&a), halves.get(&b)) else {
1143        return;
1144    };
1145    let low = ahead(func, inst, opcode, &[a_low, b_low]);
1146    let high = ahead(func, inst, opcode, &[a_high, b_high]);
1147    replace(func, halves, inst, low, high);
1148}
1149
1150/// A comparison, which produces one bit and so is pointed at its answer rather than halved.
1151///
1152/// An equality is the two halves differing in neither place, which is one `or` over two `xor`s
1153/// against zero and is shorter than comparing twice and combining. An ordering is the high halves
1154/// settling it outright, or the low halves settling it when the high halves are equal, and the low
1155/// halves are compared without a sign because the low half of a signed number is unsigned whatever
1156/// the number is.
1157///
1158/// The high halves are asked a strict question even when the predicate is not strict. A predicate
1159/// that lets the two be equal is true of two equal high halves whatever the low halves say, and
1160/// what decides it there is the low halves, so `a >= b` is `a.hi > b.hi` or the high halves being
1161/// equal and `a.lo >= b.lo` unsigned. Asking `a.hi >= b.hi` instead makes every value with a high
1162/// half of its own greater than or equal to every other, which is the shape of this that a
1163/// differential run against GCC caught.
1164fn compare(func: &mut Func, halves: &Halves, forward: &mut HashMap<Value, Value>, inst: Inst) {
1165    let Extra::IntPred(pred) = func[inst].extra else { return };
1166    let args = func[func[inst].args].to_vec();
1167    let [a, b] = args[..] else { return };
1168    let (Some(&(a_low, a_high)), Some(&(b_low, b_high))) = (halves.get(&a), halves.get(&b)) else {
1169        return;
1170    };
1171    let answer = if matches!(pred, IntPred::Eq | IntPred::Ne) {
1172        let low = ahead(func, inst, Opcode::Xor, &[a_low, b_low]);
1173        let high = ahead(func, inst, Opcode::Xor, &[a_high, b_high]);
1174        let both = ahead(func, inst, Opcode::Or, &[low, high]);
1175        let zero = ahead_const(func, inst, 0);
1176        compared(func, inst, pred, both, zero)
1177    } else {
1178        let above = compared(func, inst, strict(pred), a_high, b_high);
1179        let below = compared(func, inst, unsigned(pred), a_low, b_low);
1180        let same = compared(func, inst, IntPred::Eq, a_high, b_high);
1181        let tail = bit(func, inst, Opcode::And, same, below);
1182        bit(func, inst, Opcode::Or, above, tail)
1183    };
1184    if let Some(result) = func[inst].first_result {
1185        forward.insert(result, answer);
1186    }
1187    func.remove_inst(inst);
1188}
1189
1190/// The same ordering with the equal case taken out of it, which is what the high halves are asked.
1191fn strict(pred: IntPred) -> IntPred {
1192    match pred {
1193        IntPred::Sle => IntPred::Slt,
1194        IntPred::Sge => IntPred::Sgt,
1195        IntPred::Ule => IntPred::Ult,
1196        IntPred::Uge => IntPred::Ugt,
1197        other => other,
1198    }
1199}
1200
1201/// The same ordering with no sign in it, which is how the low halves of two signed numbers compare.
1202fn unsigned(pred: IntPred) -> IntPred {
1203    match pred {
1204        IntPred::Slt => IntPred::Ult,
1205        IntPred::Sle => IntPred::Ule,
1206        IntPred::Sgt => IntPred::Ugt,
1207        IntPred::Sge => IntPred::Uge,
1208        other => other,
1209    }
1210}
1211
1212/// A choice between two wide values, which is the same choice made on each half.
1213///
1214/// Two of them rather than one, with the condition read twice. What that costs is one more
1215/// conditional move, and what the alternative costs is a branch, which is the more expensive of the
1216/// two on anything that predicts.
1217fn choose(func: &mut Func, halves: &mut Halves, inst: Inst) {
1218    let args = func[func[inst].args].to_vec();
1219    let [cond, then, other] = args[..] else { return };
1220    let (Some(&(then_low, then_high)), Some(&(other_low, other_high))) =
1221        (halves.get(&then), halves.get(&other))
1222    else {
1223        return;
1224    };
1225    let low = ahead(func, inst, Opcode::Select, &[cond, then_low, other_low]);
1226    let high = ahead(func, inst, Opcode::Select, &[cond, then_high, other_high]);
1227    replace(func, halves, inst, low, high);
1228}
1229
1230/// Keeping the low bits of a wide value, which is the low half and then whatever is left to do.
1231///
1232/// Down to sixty four there is nothing left to do and the low half is the answer, so the truncation
1233/// goes and its readers read the half. Down to anything narrower the machine's own truncation still
1234/// happens, out of the half rather than out of the value that is no longer there.
1235fn truncate(func: &mut Func, halves: &Halves, forward: &mut HashMap<Value, Value>, inst: Inst) {
1236    let Some(&arg) = func[func[inst].args].first() else { return };
1237    let Some(&(low, _)) = halves.get(&arg) else { return };
1238    let Some(result) = func[inst].first_result else { return };
1239    if func[result].ty.bits() == HALF {
1240        forward.insert(result, low);
1241        func.remove_inst(inst);
1242        return;
1243    }
1244    becomes(func, inst, Opcode::Trunc, &[low]);
1245}
1246
1247/// Widening into a wide value, which is the value in the low half and its own sign or zero above.
1248fn extend(func: &mut Func, halves: &mut Halves, inst: Inst, signed: bool) {
1249    let Some(&arg) = func[func[inst].args].first() else { return };
1250    let low = if func[arg].ty.bits() == HALF {
1251        arg
1252    } else {
1253        let opcode = if signed { Opcode::SExt } else { Opcode::ZExt };
1254        ahead(func, inst, opcode, &[arg])
1255    };
1256    let high = if signed {
1257        let top = ahead_const(func, inst, i128::from(HALF - 1));
1258        ahead(func, inst, Opcode::AShr, &[low, top])
1259    } else {
1260        ahead_const(func, inst, 0)
1261    };
1262    replace(func, halves, inst, low, high);
1263}
1264
1265/// A call, as a call passing and receiving halves.
1266///
1267/// The instruction is made again rather than edited, because how many values a call gives back is
1268/// settled when it is created and a wide return value is two where it was one. Its signature is
1269/// made again for the same reason, since the signature is what each end of the call lays itself out
1270/// against and both ends are split the same way.
1271fn call(
1272    func: &mut Func,
1273    conv: &CallRegs,
1274    halves: &mut Halves,
1275    forward: &mut HashMap<Value, Value>,
1276    inst: Inst,
1277) {
1278    let data = func[inst];
1279    let Extra::Call(info) = data.extra else { return };
1280    let info = func[info];
1281    let Some((whole, variadic)) = site(func, inst) else { return };
1282    let old = func[data.args].to_vec();
1283    // An indirect call's first operand is the address it calls, and the arguments come after it.
1284    let skip = usize::from(data.opcode == Opcode::CallIndirect);
1285    let Some(slots) = plan(&whole, conv) else { return };
1286    let mut args = spread(&old[..skip], halves);
1287    for slot in slots.iter().copied() {
1288        let value = match slot {
1289            Slot::Whole(index) => old[skip + index],
1290            Slot::Low(index) => halves[&old[skip + index]].0,
1291            Slot::High(index) => halves[&old[skip + index]].1,
1292            Slot::Filler(ty) if ty.is_float() => {
1293                let extra = Extra::Imm(func.add_imm(Imm::from_bits(0)));
1294                written(func, inst, InstData { extra, ..InstData::new(Opcode::FConst) }, ty)
1295            }
1296            Slot::Filler(_) => ahead_const(func, inst, 0),
1297        };
1298        args.push(value);
1299    }
1300    let results: Vec<Type> = data
1301        .results()
1302        .map(|value| func[value].ty)
1303        .flat_map(|ty| if is_wide(ty) { vec![half(), half()] } else { vec![ty] })
1304        .collect();
1305    let signature = func.add_signature(planned(&Signature { variadic, ..whole }, &slots));
1306    // What the ABI asks of each argument past the `...` is on the parameter it became now, so the
1307    // call names none of them any more and the list it kept that in is empty.
1308    let varargs = if variadic { func.push_abis(&[]) } else { info.varargs };
1309    let extra = Extra::Call(func.add_call(CallInfo { signature, varargs, ..info }));
1310    let args = func.push_values(&args);
1311    let span = func.span(inst);
1312    let made = func.create_inst(InstData { args, extra, ..data }, &results, span);
1313    func.insert_before(made, inst);
1314    let mut fresh = func[made].results();
1315    for old in data.results() {
1316        if is_wide(func[old].ty) {
1317            let (Some(low), Some(high)) = (fresh.next(), fresh.next()) else { return };
1318            halves.insert(old, (low, high));
1319        } else if let Some(again) = fresh.next() {
1320            forward.insert(old, again);
1321        }
1322    }
1323    func.remove_inst(inst);
1324}
1325
1326/// Everything one call passes as the one list of parameters it is laid out as, and whether the
1327/// callee is variadic.
1328///
1329/// A variadic callee's signature names the parameters in front of the `...` and nothing else, and
1330/// what the ABI asks of each argument behind it is on the call. Here those become parameters too,
1331/// each with what the call said about it, which is the list the convention lays out anyway: on
1332/// System V an argument past the `...` goes where it would have gone had it been named, and the
1333/// one thing the callee is told is how many vector registers were used, which is a count over all
1334/// of them. The list comes back not variadic so [`plan`] lays it out as a whole, and the flag is
1335/// handed back beside it for the signature the call is made against.
1336fn site(func: &Func, inst: Inst) -> Option<(Signature, bool)> {
1337    let data = func[inst];
1338    let Extra::Call(info) = data.extra else { return None };
1339    let info = func[info];
1340    let mut whole = func[info.signature].clone();
1341    let skip = usize::from(data.opcode == Opcode::CallIndirect);
1342    let args = &func[data.args];
1343    let named = skip + whole.params.len();
1344    if args.len() < named {
1345        return None;
1346    }
1347    let beyond = &func[info.varargs];
1348    for (index, &value) in args[named..].iter().enumerate() {
1349        let abi = beyond.get(index).copied().unwrap_or_default();
1350        whole.params.push(Param { ty: func[value].ty, abi });
1351    }
1352    let variadic = whole.variadic;
1353    whole.variadic = false;
1354    Some((whole, variadic))
1355}
1356
1357/// A `return`, whose operands are the values the signature says and so are halves now.
1358fn flatten(func: &mut Func, halves: &Halves, inst: Inst) {
1359    let args = spread(&func[func[inst].args], halves);
1360    func[inst].args = func.push_values(&args);
1361}
1362
1363/// A branch, whose arguments hang on the edge rather than on the instruction.
1364fn edges(func: &mut Func, halves: &Halves, inst: Inst) {
1365    for at in func.target_list(inst).iter() {
1366        let call = func[at];
1367        let args = func[call.args].to_vec();
1368        if !args.iter().any(|value| halves.contains_key(value)) {
1369            continue;
1370        }
1371        let args = func.push_values(&spread(&args, halves));
1372        func.set_block_call(at, BlockCall { args, ..call });
1373    }
1374}
1375
1376/// A list of values with each wide one replaced by its two halves in the same position.
1377fn spread(args: &[Value], halves: &Halves) -> Vec<Value> {
1378    args.iter()
1379        .flat_map(|value| match halves.get(value) {
1380            Some(&(low, high)) => vec![low, high],
1381            None => vec![*value],
1382        })
1383        .collect()
1384}
1385
1386/// One signature with every wide parameter and return value as two halves in its place.
1387///
1388/// Each half is plain. What the ABI asks beyond a type is about the bits above a narrow value and
1389/// about an object whose address travels, and a half is neither: it is exactly a register wide and
1390/// it is the value itself.
1391fn split_signature(signature: &Signature) -> Signature {
1392    let split = |params: &[Param]| -> Vec<Param> {
1393        params
1394            .iter()
1395            .flat_map(|param| {
1396                if is_wide(param.ty) {
1397                    vec![Param::new(half()), Param::new(half())]
1398                } else {
1399                    vec![*param]
1400                }
1401            })
1402            .collect()
1403    };
1404    Signature {
1405        params: split(&signature.params),
1406        returns: split(&signature.returns),
1407        variadic: signature.variadic,
1408    }
1409}
1410
1411/// Records the two halves an instruction became and takes the instruction out.
1412fn replace(func: &mut Func, halves: &mut Halves, inst: Inst, low: Value, high: Value) {
1413    if let Some(result) = func[inst].first_result {
1414        halves.insert(result, (low, high));
1415    }
1416    func.remove_inst(inst);
1417}
1418
1419/// Points every reader of a value this pass replaced at what replaced it.
1420///
1421/// The arguments of each instruction and the arguments of the blocks it branches to, which between
1422/// them are everywhere a value can be read. Nothing chases, because every value this map answers
1423/// with is one made here and so is never itself a key.
1424fn substitute(func: &mut Func, forward: &HashMap<Value, Value>) {
1425    if forward.is_empty() {
1426        return;
1427    }
1428    let with = |value: Value| forward.get(&value).copied().unwrap_or(value);
1429    for block in func.blocks().collect::<Vec<_>>() {
1430        for inst in func.insts(block).collect::<Vec<Inst>>() {
1431            let args = func[inst].args;
1432            func.rewrite(args, with);
1433            for call in func.successors(inst).collect::<Vec<_>>() {
1434                func.rewrite(call.args, with);
1435            }
1436        }
1437    }
1438}
1439
1440/// The access one word of a wide access is, that many bytes into it.
1441fn word(info: MemInfo, at: u64) -> MemInfo {
1442    let align = if at == 0 { info.align } else { info.align.min(8) };
1443    MemInfo { size: STEP, align, ..info }
1444}
1445
1446/// The address one word past another, written in front of an instruction.
1447fn stepped(func: &mut Func, inst: Inst, from: Value) -> Value {
1448    let step = ahead_const(func, inst, i128::from(STEP));
1449    let args = func.push_values(&[from, step]);
1450    written(func, inst, InstData { args, ..InstData::new(Opcode::PtrAdd) }, Type::PTR)
1451}
1452
1453/// A load put in front of an instruction, and the half it reads.
1454fn read(func: &mut Func, inst: Inst, from: Value, info: MemInfo, flags: Flags) -> Value {
1455    let extra = Extra::Mem(func.add_mem(info));
1456    let args = func.push_values(&[from]);
1457    let data = InstData { args, flags, extra, ..InstData::new(Opcode::Load) };
1458    written(func, inst, data, half())
1459}
1460
1461/// A store put in front of an instruction, which produces nothing and is only its effect.
1462fn write(func: &mut Func, inst: Inst, value: Value, into: Value, info: MemInfo, flags: Flags) {
1463    let span = func.span(inst);
1464    let extra = Extra::Mem(func.add_mem(info));
1465    let args = func.push_values(&[value, into]);
1466    let data = InstData { args, flags, extra, ..InstData::new(Opcode::Store) };
1467    let made = func.create_inst(data, &[], span);
1468    func.insert_before(made, inst);
1469}
1470
1471/// A comparison written in front of an instruction, which carries its predicate where everything
1472/// else carries nothing.
1473fn compared(func: &mut Func, inst: Inst, pred: IntPred, lhs: Value, rhs: Value) -> Value {
1474    let args = func.push_values(&[lhs, rhs]);
1475    let extra = Extra::IntPred(pred);
1476    written(func, inst, InstData { args, extra, ..InstData::new(Opcode::ICmp) }, Type::I1)
1477}
1478
1479/// An `and` or an `or` over two truth values, which is the same instruction at the width of one.
1480fn bit(func: &mut Func, inst: Inst, opcode: Opcode, lhs: Value, rhs: Value) -> Value {
1481    let args = func.push_values(&[lhs, rhs]);
1482    written(func, inst, InstData { args, ..InstData::new(opcode) }, Type::I1)
1483}
1484
1485/// An instruction over these operands put in front of another one, producing a half.
1486fn ahead(func: &mut Func, inst: Inst, opcode: Opcode, args: &[Value]) -> Value {
1487    let args = func.push_values(args);
1488    written(func, inst, InstData { args, ..InstData::new(opcode) }, half())
1489}
1490
1491/// A constant half put in front of an instruction.
1492fn ahead_const(func: &mut Func, inst: Inst, value: i128) -> Value {
1493    let extra = Extra::Imm(func.add_imm(Imm::int(value, half())));
1494    written(func, inst, InstData { extra, ..InstData::new(Opcode::IConst) }, half())
1495}
1496
1497/// Creates the instruction, puts it in front of another, and reads its value back out.
1498fn written(func: &mut Func, inst: Inst, data: InstData, ty: Type) -> Value {
1499    let span = func.span(inst);
1500    let made = func.create_inst(data, &[ty], span);
1501    func.insert_before(made, inst);
1502    func[made].first_result.expect("an instruction created with one result has one")
1503}
1504
1505/// Turns an instruction into a different one over different operands, in place.
1506fn becomes(func: &mut Func, inst: Inst, opcode: Opcode, args: &[Value]) {
1507    let args = func.push_values(args);
1508    let data = &mut func[inst];
1509    data.opcode = opcode;
1510    data.args = args;
1511    data.extra = Extra::None;
1512    data.flags = data.flags.intersection(Flags::legal_on(opcode));
1513}
1514
1515#[cfg(test)]
1516mod tests {
1517    use rucc_base::Interner;
1518    use rucc_ir::{
1519        Abi, Block, Builder, Flags, Float, Func, MemOrder, Module, Restrict, Signature, Type, Value,
1520    };
1521    use rucc_target::x86_64::{MINGW64, SYSV};
1522    use rucc_target::{Arch, Env, Os, TargetInfo, Triple};
1523
1524    use super::{Def, Extra, HALF, IntPred, MemInfo, Opcode, halves};
1525
1526    /// The width the pass is about, as a type, which is what every test builds with.
1527    fn wide() -> Type {
1528        Type::int(super::WIDE)
1529    }
1530
1531    fn target() -> TargetInfo {
1532        TargetInfo::new(Triple::new(Arch::X86_64, Os::Linux, Env::Gnu))
1533    }
1534
1535    fn printed(func: &Func, names: &mut Interner) -> String {
1536        let module = Module::new(names.intern("w.c"), &target());
1537        rucc_ir::print_func(&module, func, names)
1538    }
1539
1540    /// A function of those parameters returning that, with its entry block and its parameters.
1541    fn shell(names: &mut Interner, params: &[Type], returns: &[Type]) -> (Func, Block, Vec<Value>) {
1542        let signature = Signature::new().with_params(params).with_returns(returns);
1543        let mut func = Func::new(names.intern("f"), signature);
1544        let entry = func.create_block();
1545        let values = params.iter().map(|&ty| func.append_param(entry, ty)).collect();
1546        (func, entry, values)
1547    }
1548
1549    /// An ordinary access of that many bytes, aligned that far.
1550    fn info(size: u64, align: u32) -> MemInfo {
1551        MemInfo {
1552            size,
1553            align,
1554            order: MemOrder::NotAtomic,
1555            tbaa: None,
1556            owns: 0,
1557            restrict: Restrict::NONE,
1558        }
1559    }
1560
1561    #[test]
1562    fn an_add_carries_from_the_low_half_into_the_high_one() {
1563        let mut names = Interner::new();
1564        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1565        let mut build = Builder::new(&mut func, entry);
1566        let sum = build.binary(Opcode::Add, params[0], params[1], Flags::NONE);
1567        build.ret(&[sum]);
1568
1569        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1570        let text = printed(&func, &mut names);
1571        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1572        // Two adds for the halves, one more for the carry, and the carry itself is the unsigned
1573        // comparison that says the low half wrapped.
1574        assert_eq!(text.matches(" = add ").count(), 3, "three adds: {text}");
1575        assert_eq!(text.matches("icmp ult").count(), 1, "one carry: {text}");
1576        assert_eq!(text.matches(" = zext.i64 ").count(), 1, "the carry as a number: {text}");
1577    }
1578
1579    #[test]
1580    fn a_subtract_borrows_the_other_way_round() {
1581        let mut names = Interner::new();
1582        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1583        let mut build = Builder::new(&mut func, entry);
1584        let difference = build.binary(Opcode::Sub, params[0], params[1], Flags::NONE);
1585        build.ret(&[difference]);
1586
1587        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1588        let text = printed(&func, &mut names);
1589        assert_eq!(text.matches(" = sub ").count(), 3, "three subtracts: {text}");
1590        // The borrow is the operands compared, not the answer, which is what tells a reader the
1591        // two directions were thought about separately.
1592        assert!(text.contains("icmp ult %0, %2"), "the operands are compared: {text}");
1593    }
1594
1595    #[test]
1596    fn the_signature_and_the_entry_block_say_the_same_thing() {
1597        let mut names = Interner::new();
1598        let (mut func, entry, params) = shell(&mut names, &[Type::int(32), wide()], &[wide()]);
1599        let mut build = Builder::new(&mut func, entry);
1600        build.ret(&[params[1]]);
1601
1602        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1603        assert_eq!(
1604            func.signature().param_types().collect::<Vec<_>>(),
1605            [Type::int(32), Type::int(HALF), Type::int(HALF)],
1606            "the wide parameter became two where it stood"
1607        );
1608        assert_eq!(
1609            func.signature().return_types().collect::<Vec<_>>(),
1610            [Type::int(HALF), Type::int(HALF)],
1611            "and so did what comes back"
1612        );
1613        let text = printed(&func, &mut names);
1614        assert!(text.contains("block0(%0: i32, %1: i64, %2: i64)"), "the block agrees: {text}");
1615        assert!(text.contains("return %1, %2"), "both halves go back: {text}");
1616        let _ = entry;
1617    }
1618
1619    #[test]
1620    fn a_read_takes_the_high_word_a_word_above_the_low_one() {
1621        let mut names = Interner::new();
1622        let (mut func, entry, params) = shell(&mut names, &[Type::PTR], &[wide()]);
1623        let mut build = Builder::new(&mut func, entry);
1624        let value = build.load(wide(), params[0], info(16, 16), Flags::NONE);
1625        build.ret(&[value]);
1626
1627        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1628        let text = printed(&func, &mut names);
1629        assert_eq!(text.matches(" = load.i64 ").count(), 2, "two reads: {text}");
1630        assert!(text.contains("ptr_add"), "the high word is a word up: {text}");
1631        // The object is aligned to sixteen and its high word is not, which is the one thing
1632        // splitting an access can get wrong quietly.
1633        assert!(text.contains("align 16"), "the low word keeps what the object had: {text}");
1634        assert!(text.contains("align 8"), "the high word knows less: {text}");
1635    }
1636
1637    #[test]
1638    fn an_equality_asks_once_about_both_halves() {
1639        let mut names = Interner::new();
1640        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[Type::int(32)]);
1641        let mut build = Builder::new(&mut func, entry);
1642        let same = build.icmp(IntPred::Eq, params[0], params[1]);
1643        let answer = build.unary(Opcode::ZExt, same, Type::int(32));
1644        build.ret(&[answer]);
1645
1646        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1647        let text = printed(&func, &mut names);
1648        assert_eq!(text.matches("icmp").count(), 1, "one comparison: {text}");
1649        assert_eq!(text.matches(" = xor ").count(), 2, "the halves differ or they do not: {text}");
1650    }
1651
1652    #[test]
1653    fn an_ordering_reads_the_low_halves_without_a_sign() {
1654        let mut names = Interner::new();
1655        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[Type::int(32)]);
1656        let mut build = Builder::new(&mut func, entry);
1657        let below = build.icmp(IntPred::Slt, params[0], params[1]);
1658        let answer = build.unary(Opcode::ZExt, below, Type::int(32));
1659        build.ret(&[answer]);
1660
1661        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1662        let text = printed(&func, &mut names);
1663        assert!(text.contains("icmp slt"), "the high halves keep the sign: {text}");
1664        assert!(text.contains("icmp ult"), "the low halves have none: {text}");
1665        assert!(
1666            text.contains("icmp eq"),
1667            "and the low halves only matter when the high tie: {text}"
1668        );
1669    }
1670
1671    /// An ordering that allows the two to be equal still asks the high halves a strict question.
1672    ///
1673    /// Two values whose high halves are equal are ordered by their low halves alone, and a high
1674    /// half that is greater than or equal to the other says nothing about that. Asking the high
1675    /// halves the predicate as it stands makes every ordering that is not strict answer yes on a
1676    /// tie, which is the mistake a run against GCC caught.
1677    #[test]
1678    fn an_ordering_that_allows_equality_asks_the_high_halves_a_strict_question() {
1679        let mut names = Interner::new();
1680        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[Type::int(32)]);
1681        let mut build = Builder::new(&mut func, entry);
1682        let at_least = build.icmp(IntPred::Sge, params[0], params[1]);
1683        let answer = build.unary(Opcode::ZExt, at_least, Type::int(32));
1684        build.ret(&[answer]);
1685
1686        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1687        let text = printed(&func, &mut names);
1688        assert!(text.contains("icmp sgt"), "the high halves settle it outright: {text}");
1689        assert!(!text.contains("icmp sge"), "a tie in the high halves settles nothing: {text}");
1690        assert!(text.contains("icmp uge"), "the low halves are the ones allowed to tie: {text}");
1691    }
1692
1693    #[test]
1694    fn a_widening_puts_the_sign_of_the_value_in_the_high_half() {
1695        let mut names = Interner::new();
1696        let (mut func, entry, params) = shell(&mut names, &[Type::int(32)], &[wide()]);
1697        let mut build = Builder::new(&mut func, entry);
1698        let value = build.unary(Opcode::SExt, params[0], wide());
1699        build.ret(&[value]);
1700
1701        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1702        let text = printed(&func, &mut names);
1703        assert!(text.contains("sext.i64"), "the value fills the low half: {text}");
1704        assert!(text.contains("ashr"), "and its sign fills the high one: {text}");
1705    }
1706
1707    #[test]
1708    fn a_block_parameter_becomes_two_and_every_branch_passes_two() {
1709        let mut names = Interner::new();
1710        let (mut func, entry, params) = shell(&mut names, &[wide(), Type::int(32)], &[wide()]);
1711        let tail = func.create_block();
1712        let carried = func.append_param(tail, wide());
1713        let mut build = Builder::new(&mut func, entry);
1714        let zero = build.iconst(Type::int(32), 0);
1715        let taken = build.icmp(IntPred::Ne, params[1], zero);
1716        let other = build.iconst(wide(), 7);
1717        build.br_if(taken, tail, &[params[0]], tail, &[other]);
1718        let mut build = Builder::new(&mut func, tail);
1719        build.ret(&[carried]);
1720
1721        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1722        let text = printed(&func, &mut names);
1723        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1724        assert!(text.contains("block1(%7: i64, %8: i64)"), "the block takes two: {text}");
1725        assert_eq!(text.matches("block1(").count(), 3, "and both edges pass two: {text}");
1726    }
1727
1728    /// A multiply is the low halves, the two cross products, and nothing for the fourth corner.
1729    ///
1730    /// Three at the top, and four more inside the carry out of the low halves, which is a product
1731    /// at half the width again worked out the same way. What the count is really saying is that the
1732    /// two high halves are never multiplied together, because the whole of that partial product
1733    /// lands above the width.
1734    #[test]
1735    fn a_multiply_is_three_multiplies_and_the_carry_out_of_the_low_ones() {
1736        let mut names = Interner::new();
1737        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1738        let mut build = Builder::new(&mut func, entry);
1739        let product = build.binary(Opcode::Mul, params[0], params[1], Flags::NONE);
1740        build.ret(&[product]);
1741
1742        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1743        let text = printed(&func, &mut names);
1744        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1745        assert_eq!(text.matches(" = mul ").count(), 7, "three and the carry's four: {text}");
1746    }
1747
1748    /// Each of the four divisions becomes a call to the routine of that name in the runtime.
1749    ///
1750    /// The sign is in the name because it is in the answer. A quotient rounds towards zero and a
1751    /// remainder takes the sign of the dividend, so the signed routine and the unsigned one work out
1752    /// two different numbers, where a wide add is one computation that two signednesses read the
1753    /// same bits of.
1754    #[test]
1755    fn each_of_the_four_divisions_calls_the_routine_of_that_name() {
1756        for (opcode, routine) in [
1757            (Opcode::UDiv, "__udivti3"),
1758            (Opcode::SDiv, "__divti3"),
1759            (Opcode::URem, "__umodti3"),
1760            (Opcode::SRem, "__modti3"),
1761        ] {
1762            let mut names = Interner::new();
1763            let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1764            let mut build = Builder::new(&mut func, entry);
1765            let answer = build.binary(opcode, params[0], params[1], Flags::NONE);
1766            build.ret(&[answer]);
1767
1768            assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1769            let text = printed(&func, &mut names);
1770            assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1771            assert!(text.contains(&format!("call @{routine}")), "{routine} is called: {text}");
1772        }
1773    }
1774
1775    /// The call hands over four halves and takes two back, which is the shape of the routine.
1776    ///
1777    /// Low half first and the dividend first, which is what the definition of the routine was split
1778    /// into by the same code on the way in. The operands here are the entry block's parameters, so
1779    /// the four values the call passes are the four the block now takes, in order.
1780    #[test]
1781    fn a_divide_hands_over_four_halves_and_takes_two_back() {
1782        let mut names = Interner::new();
1783        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1784        let mut build = Builder::new(&mut func, entry);
1785        let quotient = build.binary(Opcode::UDiv, params[0], params[1], Flags::NONE);
1786        build.ret(&[quotient]);
1787
1788        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1789        let text = printed(&func, &mut names);
1790        assert!(text.contains("@__udivti3(%0, %1, %2, %3)"), "four halves go over: {text}");
1791        assert!(text.contains("return %4, %5"), "and two come back: {text}");
1792    }
1793
1794    /// A divide whose operands were worked out in the function calls with the halves of those.
1795    ///
1796    /// The other direction of the same rule the walk is for: the call is built where the divide was,
1797    /// so the halves of a sum computed above it exist by then, and what reaches the routine is the
1798    /// two values the sum became rather than anything at the old width.
1799    #[test]
1800    fn a_divide_of_something_computed_calls_with_the_halves_of_it() {
1801        let mut names = Interner::new();
1802        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1803        let mut build = Builder::new(&mut func, entry);
1804        let sum = build.binary(Opcode::Add, params[0], params[1], Flags::NONE);
1805        let quotient = build.binary(Opcode::SDiv, sum, params[1], Flags::NONE);
1806        build.ret(&[quotient]);
1807
1808        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1809        let text = printed(&func, &mut names);
1810        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1811        assert_eq!(text.matches(" = add ").count(), 3, "the sum is still a sum: {text}");
1812        assert_eq!(text.matches("call @__divti3").count(), 1, "one call: {text}");
1813    }
1814
1815    /// Each conversion between this width and a float becomes a call to the routine of that name.
1816    ///
1817    /// Twelve of them, which is a signed and an unsigned integer against a `float`, a `double` and a
1818    /// `_Float128` in each direction, and the table is here rather than in a comment because the
1819    /// names are the whole of what this has to get right.
1820    #[test]
1821    fn each_conversion_between_this_width_and_a_float_calls_the_routine_of_that_name() {
1822        let double = Type::float(Float::F64);
1823        let single = Type::float(Float::F32);
1824        let quad = Type::float(Float::F128);
1825        for (opcode, float, routine) in [
1826            (Opcode::SIToFP, double, "__floattidf"),
1827            (Opcode::SIToFP, single, "__floattisf"),
1828            (Opcode::UIToFP, double, "__floatuntidf"),
1829            (Opcode::UIToFP, single, "__floatuntisf"),
1830            (Opcode::SIToFP, quad, "__floattitf"),
1831            (Opcode::UIToFP, quad, "__floatuntitf"),
1832        ] {
1833            let mut names = Interner::new();
1834            let (mut func, entry, params) = shell(&mut names, &[wide()], &[float]);
1835            let mut build = Builder::new(&mut func, entry);
1836            let answer = build.unary(opcode, params[0], float);
1837            build.ret(&[answer]);
1838
1839            assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1840            let text = printed(&func, &mut names);
1841            assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1842            assert!(text.contains(&format!("call @{routine}")), "{routine} is called: {text}");
1843        }
1844        for (opcode, float, routine) in [
1845            (Opcode::FPToSI, double, "__fixdfti"),
1846            (Opcode::FPToSI, single, "__fixsfti"),
1847            (Opcode::FPToUI, double, "__fixunsdfti"),
1848            (Opcode::FPToUI, single, "__fixunssfti"),
1849            (Opcode::FPToSI, quad, "__fixtfti"),
1850            (Opcode::FPToUI, quad, "__fixunstfti"),
1851        ] {
1852            let mut names = Interner::new();
1853            let (mut func, entry, params) = shell(&mut names, &[float], &[wide()]);
1854            let mut build = Builder::new(&mut func, entry);
1855            let answer = build.unary(opcode, params[0], wide());
1856            build.ret(&[answer]);
1857
1858            assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1859            let text = printed(&func, &mut names);
1860            assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1861            assert!(text.contains(&format!("call @{routine}")), "{routine} is called: {text}");
1862        }
1863    }
1864
1865    /// A conversion up hands over two halves and takes one float back, and one coming down is the
1866    /// same call the other way round.
1867    ///
1868    /// The answer going up is not a wide value, so it is one result and the readers of the
1869    /// conversion read it, the way they read the answer of a comparison.
1870    #[test]
1871    fn a_conversion_hands_over_halves_one_way_and_takes_them_back_the_other() {
1872        let double = Type::float(Float::F64);
1873        let mut names = Interner::new();
1874        let (mut func, entry, params) = shell(&mut names, &[wide()], &[double]);
1875        let mut build = Builder::new(&mut func, entry);
1876        let answer = build.unary(Opcode::SIToFP, params[0], double);
1877        build.ret(&[answer]);
1878
1879        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1880        let text = printed(&func, &mut names);
1881        assert!(text.contains("@__floattidf(%0, %1)"), "two halves go over: {text}");
1882        assert!(text.contains("return %2"), "and one float comes back: {text}");
1883
1884        let mut names = Interner::new();
1885        let (mut func, entry, params) = shell(&mut names, &[double], &[wide()]);
1886        let mut build = Builder::new(&mut func, entry);
1887        let answer = build.unary(Opcode::FPToSI, params[0], wide());
1888        build.ret(&[answer]);
1889
1890        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1891        let text = printed(&func, &mut names);
1892        assert!(text.contains("@__fixdfti(%0)"), "the float goes over as it is: {text}");
1893        assert!(text.contains("return %1, %2"), "and two halves come back: {text}");
1894    }
1895
1896    /// A conversion against a quad is that same shape, with the quad crossing whole.
1897    ///
1898    /// Worth its own test because the two sides of it are wide for different reasons. The integer is
1899    /// a pair here because no register holds a hundred and twenty eight bits of integer, and the
1900    /// quad is one value because a vector register holds all of it, so the call this pass writes has
1901    /// two operands and one result going up and one operand and two results coming down.
1902    #[test]
1903    fn a_conversion_against_a_quad_hands_over_the_pair_and_the_quad_whole() {
1904        let quad = Type::float(Float::F128);
1905        let mut names = Interner::new();
1906        let (mut func, entry, params) = shell(&mut names, &[wide()], &[quad]);
1907        let mut build = Builder::new(&mut func, entry);
1908        let answer = build.unary(Opcode::UIToFP, params[0], quad);
1909        build.ret(&[answer]);
1910
1911        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1912        let text = printed(&func, &mut names);
1913        assert!(text.contains("@__floatuntitf(%0, %1)"), "two halves go over: {text}");
1914        assert!(text.contains("return %2"), "and one quad comes back: {text}");
1915
1916        let mut names = Interner::new();
1917        let (mut func, entry, params) = shell(&mut names, &[quad], &[wide()]);
1918        let mut build = Builder::new(&mut func, entry);
1919        let answer = build.unary(Opcode::FPToSI, params[0], wide());
1920        build.ret(&[answer]);
1921
1922        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1923        let text = printed(&func, &mut names);
1924        assert!(text.contains("@__fixtfti(%0)"), "the quad goes over as it is: {text}");
1925        assert!(text.contains("return %1, %2"), "and two halves come back: {text}");
1926    }
1927
1928    /// A conversion at a float width the runtime has no routine for leaves the function alone.
1929    ///
1930    /// `long double` is the eighty bit float on this target and the runtime has no conversion for
1931    /// it, because the back end has no register that holds one, which is tamnd/rucc#326. So the
1932    /// function keeps its wide values and is refused below by name, rather than being turned into a
1933    /// call to a routine nothing defines.
1934    #[test]
1935    fn a_conversion_at_a_width_the_runtime_has_no_routine_for_is_left_alone() {
1936        let long = Type::float(Float::F80);
1937        let mut names = Interner::new();
1938        let (mut func, entry, params) = shell(&mut names, &[wide()], &[long]);
1939        let mut build = Builder::new(&mut func, entry);
1940        let answer = build.unary(Opcode::SIToFP, params[0], long);
1941        build.ret(&[answer]);
1942
1943        assert!(!halves(&mut func, &mut names, &SYSV), "the pass does not understand this one");
1944        let text = printed(&func, &mut names);
1945        assert!(text.contains("i128"), "the width is still there: {text}");
1946    }
1947
1948    /// A shift left moves each half and chooses between the count having crossed a half and not.
1949    ///
1950    /// Two shifts left, one per half, and the low one does for both cases: a count that reached a
1951    /// whole half puts exactly that value in the high half and nothing in the low one, so the only
1952    /// thing the far case needs is the shift the near case already did. Two right shifts carry the
1953    /// crossing bits, two selects pick a half each, and there is no branch anywhere.
1954    #[test]
1955    fn a_shift_left_chooses_between_a_count_that_crossed_a_half_and_one_that_did_not() {
1956        let mut names = Interner::new();
1957        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1958        let mut build = Builder::new(&mut func, entry);
1959        let moved = build.binary(Opcode::Shl, params[0], params[1], Flags::NONE);
1960        build.ret(&[moved]);
1961
1962        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1963        let text = printed(&func, &mut names);
1964        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
1965        assert_eq!(
1966            text.matches(" = shl ").count(),
1967            2,
1968            "one per half, and the far case reuses one: {text}"
1969        );
1970        assert_eq!(text.matches(" = select.i64 ").count(), 2, "one choice per half: {text}");
1971        assert_eq!(text.matches(" = lshr ").count(), 2, "the crossing bits, in two steps: {text}");
1972    }
1973
1974    /// The bits that cross move one place and then the rest, so a count of zero carries nothing.
1975    ///
1976    /// Sixty four less a count of zero is sixty four, which is not a distance a sixty four bit shift
1977    /// has. One place first and sixty three less the count after is the same distance everywhere the
1978    /// question is asked, and for a count of zero it moves a value whose top bit has already gone
1979    /// all the way out, which leaves the zero a half that did not move should carry.
1980    #[test]
1981    fn the_bits_that_cross_move_one_place_and_then_the_rest_of_the_way() {
1982        let mut names = Interner::new();
1983        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
1984        let mut build = Builder::new(&mut func, entry);
1985        let moved = build.binary(Opcode::LShr, params[0], params[1], Flags::NONE);
1986        build.ret(&[moved]);
1987
1988        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
1989        let text = printed(&func, &mut names);
1990        assert!(text.contains("iconst.i64 63"), "sixty three is the distance left: {text}");
1991        assert!(text.contains("iconst.i64 1"), "after the one place that comes first: {text}");
1992        assert!(text.contains(" = sub "), "the rest of the way is worked out: {text}");
1993        assert!(
1994            !text.contains("iconst.i64 127"),
1995            "and the count is not masked to the width: {text}"
1996        );
1997    }
1998
1999    /// An arithmetic shift right leaves the sign bit behind where a logical one leaves zeroes.
2000    ///
2001    /// What the two differ in is only the half the count moved out of entirely. A logical shift puts
2002    /// zeroes there, which is a constant already in hand, and an arithmetic one puts the sign bit
2003    /// spread across the half it came from, which is one more shift.
2004    #[test]
2005    fn an_arithmetic_shift_right_leaves_the_sign_bit_where_a_logical_one_leaves_zeroes() {
2006        let mut names = Interner::new();
2007        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
2008        let mut build = Builder::new(&mut func, entry);
2009        let moved = build.binary(Opcode::AShr, params[0], params[1], Flags::NONE);
2010        build.ret(&[moved]);
2011
2012        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2013        let text = printed(&func, &mut names);
2014        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
2015        // The high half by the count, and the high half by sixty three for the half left empty.
2016        assert_eq!(text.matches(" = ashr ").count(), 2, "the count and the sign: {text}");
2017        assert_eq!(text.matches(" = lshr ").count(), 1, "the low half is not signed: {text}");
2018        assert_eq!(text.matches(" = select.i64 ").count(), 2, "one choice per half: {text}");
2019    }
2020
2021    /// A wide parameter that gets no register pair, as the function's own parameter.
2022    ///
2023    /// The whole value goes in the argument area and the register it could not use stays empty,
2024    /// so the split signature has a filler where that register is and the two halves after it.
2025    /// What the function reads from the low half is the parameter the filler is followed by.
2026    fn arrived(params: &[Type], wide_at: usize) -> (Signature, usize) {
2027        let mut names = Interner::new();
2028        let word = Type::int(HALF);
2029        let (mut func, entry, values) = shell(&mut names, params, &[word]);
2030        let mut build = Builder::new(&mut func, entry);
2031        let low = build.unary(Opcode::Trunc, values[wide_at], word);
2032        build.ret(&[low]);
2033
2034        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2035        let ret = func.insts(entry).last().expect("the block ends in a return");
2036        let read = func[func[ret].args][0];
2037        let at = func[entry].params.iter().position(|&value| value == read);
2038        (func.signature().clone(), at.expect("the low half is a parameter"))
2039    }
2040
2041    fn types(signature: &Signature) -> Vec<Type> {
2042        signature.params.iter().map(|param| param.ty).collect()
2043    }
2044
2045    #[test]
2046    fn a_parameter_with_one_register_left_goes_in_memory_and_the_register_stays_empty() {
2047        let word = Type::int(HALF);
2048        let (signature, low) = arrived(&[word, word, word, word, word, wide()], 5);
2049        assert_eq!(types(&signature), vec![word; 8], "five, a filler and two halves");
2050        assert_eq!(low, 6, "the halves come after the register the value skipped");
2051    }
2052
2053    #[test]
2054    fn the_register_a_wide_parameter_skipped_goes_to_the_parameter_after_it() {
2055        let word = Type::int(HALF);
2056        let (signature, low) = arrived(&[word, word, word, word, word, wide(), word], 5);
2057        assert_eq!(types(&signature), vec![word; 8], "six registers and two words, no filler");
2058        assert_eq!(low, 6, "the word after the wide value took the sixth register");
2059    }
2060
2061    #[test]
2062    fn a_wide_parameter_in_memory_starts_on_a_sixteen_byte_boundary() {
2063        let word = Type::int(HALF);
2064        let params = [word, word, word, word, word, word, word, wide()];
2065        let (signature, low) = arrived(&params, 7);
2066        assert_eq!(types(&signature), vec![word; 10], "the seventh word, a filler, the halves");
2067        assert_eq!(low, 8, "the filler takes the word the alignment leaves empty");
2068    }
2069
2070    /// The same layout on the calling side, with a constant in the place of the filler.
2071    #[test]
2072    fn a_call_passes_a_wide_argument_in_memory_the_way_the_callee_reads_it() {
2073        let mut names = Interner::new();
2074        let word = Type::int(HALF);
2075        let (mut func, entry, _) = shell(&mut names, &[], &[]);
2076        let callee = names.intern("g");
2077        let params = [word, word, word, word, word, wide()];
2078        let signature = func.add_signature(Signature::new().with_params(&params));
2079        let mut build = Builder::new(&mut func, entry);
2080        let one = build.iconst(word, 1);
2081        let big = build.iconst(wide(), 4);
2082        build.call(callee, signature, &[one, one, one, one, one, big]);
2083        build.ret(&[]);
2084
2085        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2086        let call = func.insts(entry).find(|&inst| func[inst].opcode == Opcode::Call);
2087        let call = call.expect("the call is still there");
2088        let Extra::Call(info) = func[call].extra else { unreachable!("a call has call info") };
2089        let passed = func[func[call].args].to_vec();
2090        assert_eq!(types(&func[func[info].signature]), vec![word; 8], "as the callee has it");
2091        assert_eq!(passed.len(), 8, "one argument for each parameter");
2092        assert_eq!(passed[..5], [one; 5], "the words keep their registers");
2093        let constant = |value: Value| {
2094            let Def::Result { inst, .. } = func[value].def else { return None };
2095            let Extra::Imm(imm) = func[inst].extra else { return None };
2096            Some(func[imm].unsigned())
2097        };
2098        assert_eq!(constant(passed[6]), Some(4), "the low half is the first word in memory");
2099        assert_eq!(constant(passed[7]), Some(0), "and the high half the second");
2100    }
2101
2102    /// A variadic callee's named parameters have to stay in front of the rest, so a wide one that
2103    /// would go in memory is still refused there, by leaving the function as it was.
2104    #[test]
2105    fn a_variadic_call_with_a_wide_argument_in_memory_leaves_the_function_alone() {
2106        let mut names = Interner::new();
2107        let word = Type::int(HALF);
2108        let (mut func, entry, _) = shell(&mut names, &[], &[]);
2109        let callee = names.intern("g");
2110        let params = [word, word, word, word, word, wide()];
2111        let signature = Signature { variadic: true, ..Signature::new().with_params(&params) };
2112        let signature = func.add_signature(signature);
2113        let mut build = Builder::new(&mut func, entry);
2114        let one = build.iconst(word, 1);
2115        let big = build.iconst(wide(), 4);
2116        build.call(callee, signature, &[one, one, one, one, one, big]);
2117        build.ret(&[]);
2118        let before = printed(&func, &mut names);
2119
2120        assert!(!halves(&mut func, &mut names, &SYSV), "the named parameters cannot move");
2121        assert_eq!(printed(&func, &mut names), before, "so nothing moved");
2122    }
2123
2124    /// A wide argument past the `...` is laid out as if it had been named, which is what System V
2125    /// does with it, and the call names every argument afterwards so the list of what the ABI asks
2126    /// of the unnamed ones is empty.
2127    #[test]
2128    fn a_wide_argument_past_the_dots_goes_where_a_named_one_would() {
2129        let mut names = Interner::new();
2130        let word = Type::int(HALF);
2131        let (mut func, entry, _) = shell(&mut names, &[], &[]);
2132        let callee = names.intern("g");
2133        let params = [word, word, word, word, word];
2134        let signature = Signature { variadic: true, ..Signature::new().with_params(&params) };
2135        let signature = func.add_signature(signature);
2136        let mut build = Builder::new(&mut func, entry);
2137        let one = build.iconst(word, 1);
2138        let big = build.iconst(wide(), 4);
2139        build.call_varargs(callee, signature, &[one, one, one, one, one, big], &[Abi::Plain]);
2140        build.ret(&[]);
2141
2142        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2143        let call = func.insts(entry).find(|&inst| func[inst].opcode == Opcode::Call);
2144        let call = call.expect("the call is still there");
2145        let Extra::Call(info) = func[call].extra else { unreachable!("a call has call info") };
2146        let made = &func[func[info].signature];
2147        assert!(made.variadic, "the callee is still variadic");
2148        assert_eq!(types(made), vec![word; 8], "five words, a filler and the two halves");
2149        assert!(func[func[info].varargs].is_empty(), "every argument is named now");
2150        assert_eq!(func[func[call].args].len(), 8, "one argument for each parameter");
2151    }
2152
2153    /// The same call on a convention that counts both files as one run is left alone, because
2154    /// naming a float past the `...` there changes which registers it goes in.
2155    #[test]
2156    fn a_wide_argument_past_the_dots_on_windows_leaves_the_function_alone() {
2157        let mut names = Interner::new();
2158        let word = Type::int(HALF);
2159        let (mut func, entry, _) = shell(&mut names, &[], &[]);
2160        let callee = names.intern("g");
2161        let signature = Signature { variadic: true, ..Signature::new().with_params(&[word]) };
2162        let signature = func.add_signature(signature);
2163        let mut build = Builder::new(&mut func, entry);
2164        let one = build.iconst(word, 1);
2165        let big = build.iconst(wide(), 4);
2166        build.call_varargs(callee, signature, &[one, big], &[Abi::Plain]);
2167        build.ret(&[]);
2168
2169        assert!(!halves(&mut func, &mut names, &MINGW64), "the call is left for a refusal");
2170    }
2171
2172    /// The order the function holds its blocks in is not the order they run in.
2173    ///
2174    /// This is what the optimizer produced and `-O0` did not. A block that runs early is made late
2175    /// by whichever pass needed it, so the list the function keeps had a use of a wide value in it
2176    /// before the instruction defining that value, and the walk that asks whether every definition
2177    /// comes first said no and left the whole function alone. Then the selector met an instruction
2178    /// at a width it has no register for and refused the program. The blocks here are made in the
2179    /// order that produces, which is the tail before the middle. tamnd/rucc#1054.
2180    #[test]
2181    fn a_block_made_after_the_one_it_runs_before_is_still_split() {
2182        let mut names = Interner::new();
2183        let (mut func, entry, params) = shell(&mut names, &[wide()], &[wide()]);
2184        let tail = func.create_block();
2185        let middle = func.create_block();
2186        let mut build = Builder::new(&mut func, entry);
2187        build.jump(middle, &[]);
2188        let mut build = Builder::new(&mut func, middle);
2189        let doubled = build.binary(Opcode::Add, params[0], params[0], Flags::NONE);
2190        build.jump(tail, &[]);
2191        let mut build = Builder::new(&mut func, tail);
2192        let again = build.binary(Opcode::Add, doubled, doubled, Flags::NONE);
2193        build.ret(&[again]);
2194
2195        assert!(
2196            halves(&mut func, &mut names, &SYSV),
2197            "the definition runs before the use whatever the list says"
2198        );
2199        let text = printed(&func, &mut names);
2200        assert!(!text.contains("i128"), "nothing that wide is left: {text}");
2201    }
2202
2203    #[test]
2204    fn a_function_with_nothing_that_wide_is_not_touched() {
2205        let mut names = Interner::new();
2206        let word = Type::int(HALF);
2207        let (mut func, entry, params) = shell(&mut names, &[word, word], &[word]);
2208        let mut build = Builder::new(&mut func, entry);
2209        let sum = build.binary(Opcode::Add, params[0], params[1], Flags::NONE);
2210        build.ret(&[sum]);
2211
2212        assert!(!halves(&mut func, &mut names, &SYSV), "there is nothing to split");
2213    }
2214
2215    /// The operands of a runtime call go over the way the target's convention passes them.
2216    ///
2217    /// Windows x64 passes a scalar of a size no register holds as the address of a copy the caller
2218    /// made, so libgcc's `__floattitf` there reads its integer out of the address in `rdx` and
2219    /// writes its answer through the address in `rcx`. Handing it two halves in registers instead is
2220    /// not a worse encoding of the same call, it is a routine reading registers nothing was put in.
2221    #[test]
2222    fn on_windows_a_wide_operand_goes_over_as_the_address_of_a_copy() {
2223        let mut names = Interner::new();
2224        let quad = Type::float(Float::F64);
2225        let (mut func, entry, params) = shell(&mut names, &[wide()], &[quad]);
2226        let mut build = Builder::new(&mut func, entry);
2227        let answer = build.unary(Opcode::SIToFP, params[0], quad);
2228        build.ret(&[answer]);
2229
2230        assert!(halves(&mut func, &mut names, &MINGW64), "there is a width to split");
2231        let text = printed(&func, &mut names);
2232        assert!(text.contains("call @__floattidf"), "{text}");
2233        // One slot with the two halves written into it, and the address of it is the argument.
2234        assert_eq!(text.matches("alloca").count(), 1, "one slot: {text}");
2235        assert_eq!(text.matches("store").count(), 2, "a half at a time: {text}");
2236        assert_eq!(text.matches("ptr_add").count(), 1, "the high half eight bytes up: {text}");
2237        assert!(!text.contains("__floattidf(%0, %1)"), "not the two halves: {text}");
2238    }
2239
2240    /// An answer the convention brings back through an address is the leading argument.
2241    #[test]
2242    fn on_windows_a_wide_answer_at_this_format_comes_back_through_a_slot() {
2243        let mut names = Interner::new();
2244        let quad = Type::float(Float::F128);
2245        let (mut func, entry, params) = shell(&mut names, &[wide()], &[quad]);
2246        let mut build = Builder::new(&mut func, entry);
2247        let answer = build.unary(Opcode::SIToFP, params[0], quad);
2248        build.ret(&[answer]);
2249
2250        assert!(halves(&mut func, &mut names, &MINGW64), "there is a width to split");
2251        let text = printed(&func, &mut names);
2252        assert!(text.contains("call @__floattitf"), "{text}");
2253        // The slot for the answer and the slot for the operand.
2254        assert_eq!(text.matches("alloca").count(), 2, "two slots: {text}");
2255        assert_eq!(text.matches(" = call").count(), 0, "the call answers nothing: {text}");
2256        assert_eq!(text.matches(" = load").count(), 1, "the answer is the load after it: {text}");
2257    }
2258
2259    /// The convention that hands the halves over in registers is left exactly as it was.
2260    #[test]
2261    fn the_convention_with_registers_for_both_halves_puts_nothing_on_the_frame() {
2262        let mut names = Interner::new();
2263        let double = Type::float(Float::F64);
2264        let (mut func, entry, params) = shell(&mut names, &[wide()], &[double]);
2265        let mut build = Builder::new(&mut func, entry);
2266        let answer = build.unary(Opcode::SIToFP, params[0], double);
2267        build.ret(&[answer]);
2268
2269        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2270        let text = printed(&func, &mut names);
2271        assert!(text.contains("@__floattidf(%0, %1)"), "both halves in registers: {text}");
2272        assert!(!text.contains("alloca"), "nothing goes through the frame: {text}");
2273    }
2274
2275    /// An answer at this width on Windows, which comes back whole in a vector register and is taken
2276    /// apart through a slot rather than read out of two of them.
2277    #[test]
2278    fn on_windows_a_wide_answer_comes_back_in_one_register_and_is_split_on_the_frame() {
2279        let mut names = Interner::new();
2280        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
2281        let mut build = Builder::new(&mut func, entry);
2282        let answer = build.binary(Opcode::SDiv, params[0], params[1], Flags::NONE);
2283        build.ret(&[answer]);
2284
2285        assert!(halves(&mut func, &mut names, &MINGW64), "there is a width to split");
2286        let text = printed(&func, &mut names);
2287        // The call answers one value and it is at the quad format, which is the name this compiler
2288        // has for sixteen bytes in a vector register.
2289        assert!(text.contains("call @__divti3(%4, %7) : (ptr, ptr) -> f128"), "{text}");
2290        assert_eq!(text.matches(" = call").count(), 1, "one answer: {text}");
2291        // Two slots for the two operands and one more to take the answer apart in.
2292        assert_eq!(text.matches("alloca").count(), 3, "three slots: {text}");
2293        assert_eq!(text.matches(" = load").count(), 2, "the two halves: {text}");
2294    }
2295
2296    /// The same division where the convention has a pair of registers for the answer.
2297    #[test]
2298    fn the_convention_with_registers_for_the_answer_reads_both_halves_out_of_them() {
2299        let mut names = Interner::new();
2300        let (mut func, entry, params) = shell(&mut names, &[wide(), wide()], &[wide()]);
2301        let mut build = Builder::new(&mut func, entry);
2302        let answer = build.binary(Opcode::SDiv, params[0], params[1], Flags::NONE);
2303        build.ret(&[answer]);
2304
2305        assert!(halves(&mut func, &mut names, &SYSV), "there is a width to split");
2306        let text = printed(&func, &mut names);
2307        assert!(text.contains("@__divti3(%0, %1, %2, %3)"), "four halves over: {text}");
2308        assert!(!text.contains("alloca"), "nothing goes through the frame: {text}");
2309    }
2310}