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