llvm-native-core 0.1.9

//! SPARC Instruction Selection — converts LLVM IR to SPARC
//! machine instructions.
//!
//! Clean-room behavioral reconstruction from the SPARC Architecture
//! Manual v8/v9. Zero LLVM source consultation.
//!
//! This module implements the instruction selector that lowers
//! LLVM IR opcodes to SPARC machine instructions using the
//! patterns defined by the SPARC instruction set architecture.
//!
//! # Lowering patterns (canonical SPARC mappings)
//!
//! | IR op       | SPARC instruction(s)                      |
//! |-------------|------------------------------------------|
//! | `add`       | `ADD rd, rs1, rs2` / `ADD rd, rs1, imm` |
//! | `sub`       | `SUB rd, rs1, rs2`                       |
//! | `mul`       | `SMUL/UMUL rd, rs1, rs2` (v8: MULX v9)  |
//! | `sdiv`      | `SDIV rd, rs1, rs2` (v9: SDIVX)         |
//! | `and`       | `AND rd, rs1, rs2`                       |
//! | `or`        | `OR rd, rs1, rs2`                        |
//! | `xor`       | `XOR rd, rs1, rs2`                       |
//! | `shl`       | `SLL rd, rs1, rs2`                       |
//! | `lshr`      | `SRL rd, rs1, rs2`                       |
//! | `ashr`      | `SRA rd, rs1, rs2`                       |
//! | `icmp eq`   | `SUBcc rs1, rs2, %g0; BE label`          |
//! | `br`        | `BA label`                               |
//! | `br cond`   | `BNE/BE label`                           |
//! | `call`      | `CALL target` / `JMPL target, %o7`      |
//! | `ret`       | `RET` / `RETL`                           |
//! | `load`      | `LD rd, [rs1+rs2]`                       |
//! | `store`     | `ST rd, [rs1+rs2]`                       |
//! | `alloca`    | `SUB %sp, size, %sp` + `ADD %sp, offset, rd` |

use super::sparc_instr_info::SparcOpcode;
use super::sparc_register_info::*;
use crate::codegen::*;
use crate::opcode::Opcode;
use crate::value::Value;
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// SparcInstructionSelector
// ---------------------------------------------------------------------------

/// SPARC instruction selector: lowers LLVM IR instructions into
/// SPARC machine instructions.
pub struct SparcInstructionSelector {
    /// Whether selecting for SPARC v9 (64-bit, true) or SPARC v8 (32-bit, false).
    pub is_64bit: bool,
    /// Map from IR value IDs (Value::vid) to virtual register numbers.
    pub vreg_map: HashMap<usize, VirtReg>,
    /// The current machine basic block being built.
    pub mbb: MachineBasicBlock,
    /// Name of the function being compiled (for label generation).
    pub func_name: String,
}

impl SparcInstructionSelector {
    /// Create a new instruction selector.
    pub fn new(is_64bit: bool) -> Self {
        SparcInstructionSelector {
            is_64bit,
            vreg_map: HashMap::new(),
            mbb: MachineBasicBlock {
                name: String::new(),
                instructions: Vec::new(),
                successors: Vec::new(),
            },
            func_name: String::new(),
        }
    }

    // ==================================================================
    // Top-level selection
    // ==================================================================

    /// Convert an entire LLVM function (as `Value`) into machine
    /// instructions, populating the given `MachineFunction`.
    pub fn select(&mut self, mf: &mut MachineFunction, func: &Value) {
        self.func_name = func.name.clone();
        if self.func_name.is_empty() {
            self.func_name = format!(".Lfunc{}", func.vid);
        }
        self.vreg_map.clear();

        for bb_ref in &func.successors {
            let bb = bb_ref.borrow();
            self.mbb = MachineBasicBlock {
                name: bb.name.clone(),
                instructions: Vec::new(),
                successors: Vec::new(),
            };

            for inst_ref in &bb.operands {
                let inst = inst_ref.borrow();
                if inst.is_instruction() {
                    let instrs = self.select_instruction(&inst);
                    self.mbb.instructions.extend(instrs);
                }
            }

            mf.push_block(self.mbb.clone());
        }
    }

    /// Select machine instructions for a single IR instruction.
    pub fn select_instruction(&mut self, inst: &Value) -> Vec<MachineInstr> {
        let opcode = match inst.get_opcode() {
            Some(op) => op,
            None => return Vec::new(),
        };

        match opcode {
            Opcode::Add => vec![self.lower_three_reg_op(inst, SparcOpcode::ADD as u32)],
            Opcode::FAdd => vec![self.lower_fp_binop(
                inst,
                SparcOpcode::FADDS as u32,
                SparcOpcode::FADDD as u32,
            )],
            Opcode::Sub => vec![self.lower_three_reg_op(inst, SparcOpcode::SUB as u32)],
            Opcode::FSub => vec![self.lower_fp_binop(
                inst,
                SparcOpcode::FSUBS as u32,
                SparcOpcode::FSUBD as u32,
            )],
            Opcode::Mul => vec![self.lower_mul_op(inst)],
            Opcode::FMul => vec![self.lower_fp_binop(
                inst,
                SparcOpcode::FMULS as u32,
                SparcOpcode::FMULD as u32,
            )],
            Opcode::SDiv => vec![self.lower_div_op(inst, true)],
            Opcode::UDiv => vec![self.lower_div_op(inst, false)],
            Opcode::FDiv => vec![self.lower_fp_binop(
                inst,
                SparcOpcode::FDIVS as u32,
                SparcOpcode::FDIVD as u32,
            )],
            Opcode::And => vec![self.lower_three_reg_op(inst, SparcOpcode::AND as u32)],
            Opcode::Or => vec![self.lower_three_reg_op(inst, SparcOpcode::OR as u32)],
            Opcode::Xor => vec![self.lower_three_reg_op(inst, SparcOpcode::XOR as u32)],
            Opcode::Shl => vec![self.lower_shift_op(inst, SparcOpcode::SLL as u32)],
            Opcode::LShr => vec![self.lower_shift_op(inst, SparcOpcode::SRL as u32)],
            Opcode::AShr => vec![self.lower_shift_op(inst, SparcOpcode::SRA as u32)],
            Opcode::ICmp => self.lower_icmp(inst),
            Opcode::Br => vec![self.lower_br(inst)],
            Opcode::Ret => vec![self.lower_ret(inst)],
            Opcode::Call => vec![self.lower_call(inst)],
            Opcode::Alloca => vec![self.lower_alloca(inst)],
            Opcode::Load => vec![self.lower_load(inst)],
            Opcode::Store => vec![self.lower_store(inst)],
            Opcode::ZExt => vec![self.lower_move(inst)],
            Opcode::SExt => vec![self.lower_move(inst)],
            Opcode::Trunc => vec![self.lower_move(inst)],
            Opcode::GetElementPtr => vec![self.lower_gep(inst)],
            Opcode::Select => self.lower_select(inst),
            _ => Vec::new(),
        }
    }

    // ==================================================================
    // Register helpers
    // ==================================================================

    /// Get or create a virtual register for an IR value.
    fn get_or_create_vreg(&mut self, val: &Value) -> VirtReg {
        let vid_key = val.vid as usize;
        if let Some(vreg) = self.vreg_map.get(&vid_key) {
            return *vreg;
        }
        let vreg = self.vreg_map.len() as u32;
        self.vreg_map.insert(vid_key, vreg);
        vreg
    }

    /// Get the virtual register assigned to an operand index of an instruction.
    fn get_vreg_for_operand(&mut self, inst: &Value, index: usize) -> VirtReg {
        if let Some(op) = inst.operands.get(index) {
            self.get_or_create_vreg(&op.borrow())
        } else {
            0
        }
    }

    // ==================================================================
    // Lowering helpers
    // ==================================================================

    /// Generic three-register operation: ADD, SUB, AND, OR, XOR.
    fn lower_three_reg_op(&mut self, inst: &Value, opcode: u32) -> MachineInstr {
        let rs1 = self.get_vreg_for_operand(inst, 0);
        let rs2 = self.get_vreg_for_operand(inst, 1);
        let rd = self.get_or_create_vreg(inst);

        let mut mi = MachineInstr::new(opcode);
        mi.push_reg(rd);
        mi.push_reg(rs1);
        mi.push_reg(rs2);
        mi.def = Some(rd);
        mi
    }

    /// Lower a shift operation: rd = rs1 << rs2 (or >> variants).
    fn lower_shift_op(&mut self, inst: &Value, opcode: u32) -> MachineInstr {
        self.lower_three_reg_op(inst, opcode)
    }

    /// Lower multiply: SPARC v9 uses MULX, v8 uses SMUL/UMUL (software trap).
    fn lower_mul_op(&mut self, inst: &Value) -> MachineInstr {
        if self.is_64bit {
            self.lower_three_reg_op(inst, SparcOpcode::MULX as u32)
        } else {
            self.lower_three_reg_op(inst, SparcOpcode::SMUL as u32)
        }
    }

    /// Lower divide: SPARC v9 uses SDIVX/UDIVX, v8 uses SDIV/UDIV.
    fn lower_div_op(&mut self, inst: &Value, signed: bool) -> MachineInstr {
        let opcode = if self.is_64bit {
            if signed {
                SparcOpcode::SDIVX as u32
            } else {
                SparcOpcode::UDIVX as u32
            }
        } else {
            if signed {
                SparcOpcode::SDIV as u32
            } else {
                SparcOpcode::UDIV as u32
            }
        };
        self.lower_three_reg_op(inst, opcode)
    }

    /// Lower floating-point binary op.
    fn lower_fp_binop(
        &mut self,
        inst: &Value,
        single_opcode: u32,
        double_opcode: u32,
    ) -> MachineInstr {
        let opcode = if self.is_64bit {
            double_opcode
        } else {
            single_opcode
        };
        self.lower_three_reg_op(inst, opcode)
    }

    /// Lower a move (simple copy: OR rd, %g0, rs).
    fn lower_move(&mut self, inst: &Value) -> MachineInstr {
        let rs = self.get_vreg_for_operand(inst, 0);
        let rd = self.get_or_create_vreg(inst);

        let mut mi = MachineInstr::new(SparcOpcode::OR as u32);
        mi.push_reg(rd);
        mi.push_reg(rs);
        mi.push_reg(0); // %g0
        mi.def = Some(rd);
        mi
    }

    // ==================================================================
    // ICmp lowering
    // ==================================================================

    /// Lower icmp: SUBcc rs1, rs2, %g0 sets ICC; then use branch.
    fn lower_icmp(&mut self, inst: &Value) -> Vec<MachineInstr> {
        let rs1 = self.get_vreg_for_operand(inst, 0);
        let rs2 = self.get_vreg_for_operand(inst, 1);
        let rd = self.get_or_create_vreg(inst);

        // SUBcc with rd=%g0 sets condition codes without changing any register
        let mut subcc = MachineInstr::new(SparcOpcode::SUBcc as u32);
        subcc.push_reg(0); // %g0 (rd)
        subcc.push_reg(rs1);
        subcc.push_reg(rs2);

        // Set rd = 1 if condition is true, else 0 (handled by later branch/cset)
        // For now, just emit the compare
        let mut mov_true = MachineInstr::new(SparcOpcode::OR as u32);
        mov_true.push_reg(rd);
        mov_true.push_reg(0); // will be fixed up
        mov_true.push_reg(0);
        mov_true.def = Some(rd);

        vec![subcc, mov_true]
    }

    // ==================================================================
    // Branch lowering
    // ==================================================================

    fn lower_br(&mut self, inst: &Value) -> MachineInstr {
        // Unconditional branch: BA label
        let mut mi = MachineInstr::new(SparcOpcode::BA as u32);
        if let Some(dest) = inst.operands.get(0) {
            let bb = dest.borrow();
            mi.push_label(&bb.name);
        }
        mi
    }

    // ==================================================================
    // Return lowering
    // ==================================================================

    fn lower_ret(&mut self, _inst: &Value) -> MachineInstr {
        // RET: jmpl %i7+8, %g0 (standard SPARC return)
        let mut mi = MachineInstr::new(SparcOpcode::RET as u32);
        mi
    }

    // ==================================================================
    // Call lowering
    // ==================================================================

    fn lower_call(&mut self, inst: &Value) -> MachineInstr {
        // CALL target
        let mut mi = MachineInstr::new(SparcOpcode::CALL as u32);
        if let Some(callee) = inst.operands.get(0) {
            let func = callee.borrow();
            mi.push_label(&func.name);
        }
        mi
    }

    // ==================================================================
    // Alloca lowering
    // ==================================================================

    fn lower_alloca(&mut self, inst: &Value) -> MachineInstr {
        let rd = self.get_or_create_vreg(inst);

        // SUB %sp, size, %sp  (allocate stack space)
        let mut sub_sp = MachineInstr::new(SparcOpcode::SUB as u32);
        sub_sp.push_reg(SP as u32); // rd
        sub_sp.push_reg(SP as u32); // rs1
                                    // rs2 = size will be patched in later
        sub_sp.push_imm(0);

        // Return %sp as the allocated pointer
        let mut mov = MachineInstr::new(SparcOpcode::OR as u32);
        mov.push_reg(rd);
        mov.push_reg(SP as u32);
        mov.push_reg(0); // %g0
        mov.def = Some(rd);
        mov
    }

    // ==================================================================
    // Load lowering
    // ==================================================================

    fn lower_load(&mut self, inst: &Value) -> MachineInstr {
        let rd = self.get_or_create_vreg(inst);
        let base = self.get_vreg_for_operand(inst, 0);

        let mut mi = MachineInstr::new(SparcOpcode::LD as u32);
        mi.push_reg(rd);
        mi.push_reg(base);
        mi.push_reg(0); // offset in %g0
        mi.def = Some(rd);
        mi
    }

    // ==================================================================
    // Store lowering
    // ==================================================================

    fn lower_store(&mut self, inst: &Value) -> MachineInstr {
        let val = self.get_vreg_for_operand(inst, 0);
        let addr = self.get_vreg_for_operand(inst, 1);

        let mut mi = MachineInstr::new(SparcOpcode::ST as u32);
        mi.push_reg(val);
        mi.push_reg(addr);
        mi.push_reg(0); // offset in %g0
        mi
    }

    // ==================================================================
    // GEP lowering
    // ==================================================================

    fn lower_gep(&mut self, inst: &Value) -> MachineInstr {
        let base = self.get_vreg_for_operand(inst, 0);
        let offset = self.get_vreg_for_operand(inst, 1);
        let rd = self.get_or_create_vreg(inst);

        let mut mi = MachineInstr::new(SparcOpcode::ADD as u32);
        mi.push_reg(rd);
        mi.push_reg(base);
        mi.push_reg(offset);
        mi.def = Some(rd);
        mi
    }

    // ==================================================================
    // Select lowering
    // ==================================================================

    fn lower_select(&mut self, inst: &Value) -> Vec<MachineInstr> {
        let cond = self.get_vreg_for_operand(inst, 0);
        let true_val = self.get_vreg_for_operand(inst, 1);
        let false_val = self.get_vreg_for_operand(inst, 2);
        let rd = self.get_or_create_vreg(inst);

        // Simple: emit conditional move using branches
        // In a real ISel this would use MOVcc but SPARC doesn't have conditional moves;
        // instead we'd select a branch sequence. For now emit a simple OR.
        let mut mi = MachineInstr::new(SparcOpcode::OR as u32);
        mi.push_reg(rd);
        mi.push_reg(true_val);
        mi.push_reg(0);
        mi.def = Some(rd);
        vec![mi]
    }
}