//! RV64I+M instruction encoding tests.

//!

//! These tests verify that instruction encodings match the RISC-V specification

//! by comparing against known-good values.

use std::testing;

use std::lang::alloc;

use std::collections::dict;

use super::encode;

use super::asm;

static ASSEMBLY_ARENA_STORAGE: [u8; 16777216] = [0; 16777216];

static ASSEMBLY_TEXT_STORAGE: [u32; 2] = [0; 2];

/// Helper to check encoding equals expected value.

fn expectEncoding(actual: u32, expected: u32) throws (testing::TestError) {

    try testing::expect(actual == expected);

}

@test unsafe fn testAddAssemblyExportsOnlyGlobalTextSymbols() throws (testing::TestError) {

    let mut arena = alloc::new(&mut ASSEMBLY_ARENA_STORAGE[..]);

    let symbols = try alloc::allocSlice(&mut arena, @sizeOf(asm::Symbol), @alignOf(asm::Symbol), 2) catch {

        throw testing::TestError::Failed;

    };

    let symbolSlice = symbols as *mut [asm::Symbol];

    set symbolSlice[0] = asm::Symbol {

        name: "local",

        section: asm::Section::Text,

        offset: 0,

        isExported: false,

    };

    set symbolSlice[1] = asm::Symbol {

        name: "exported",

        section: asm::Section::Text,

        offset: super::INSTR_SIZE,

        isExported: true,

    };

    let mut generator = try! super::beginProgram(

        super::ProgramOptions { entryPatch: super::EntryPatch::None, debug: false, placement: super::image::Placement::Hosted },

        &mut arena

    );

    super::addAssembly(

        &mut generator,

        asm::Program {

            text: &ASSEMBLY_TEXT_STORAGE[..],

            data: &[],

            symbols: symbolSlice,

            externalFixups: &[],

        }

    );

    try testing::expect(dict::get(&generator.e.labels.funcs, "local") == nil);

    let exportedOffset = dict::get(&generator.e.labels.funcs, "exported") else {

        throw testing::TestError::Failed;

    };

    try testing::expect(exportedOffset == super::INSTR_SIZE);

}

///////////////////////

// R-type ALU tests  //

///////////////////////

@test fn testEncodeAdd() throws (testing::TestError) {

    let enc = encode::add(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003100B3);

}

@test fn testEncodeSub() throws (testing::TestError) {

    let enc = encode::sub(super::reg(5), super::reg(6), super::reg(7));

    try expectEncoding(enc, 0x407302B3);

}

@test fn testEncodeSll() throws (testing::TestError) {

    let enc = encode::sll(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003110B3);

}

@test fn testEncodeSlt() throws (testing::TestError) {

    let enc = encode::slt(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003120B3);

}

@test fn testEncodeSltu() throws (testing::TestError) {

    let enc = encode::sltu(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003130B3);

}

@test fn testEncodeXor() throws (testing::TestError) {

    let enc = encode::xor(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003140B3);

}

@test fn testEncodeSrl() throws (testing::TestError) {

    let enc = encode::srl(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003150B3);

}

@test fn testEncodeSra() throws (testing::TestError) {

    let enc = encode::sra(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x403150B3);

}

@test fn testEncodeOr() throws (testing::TestError) {

    let enc = encode::or_(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003160B3);

}

@test fn testEncodeAnd() throws (testing::TestError) {

    let enc = encode::and_(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003170B3);

}

///////////////////////

// I-type ALU tests  //

///////////////////////

@test fn testEncodeAddi() throws (testing::TestError) {

    let enc = encode::addi(super::reg(1), super::ZERO, 42);

    try expectEncoding(enc, 0x02A00093);

}

@test fn testEncodeAddiNegative() throws (testing::TestError) {

    let enc = encode::addi(super::reg(1), super::ZERO, -1);

    try expectEncoding(enc, 0xFFF00093);

}

@test fn testEncodeSlti() throws (testing::TestError) {

    let enc = encode::slti(super::reg(1), super::reg(2), 100);

    try expectEncoding(enc, 0x06412093);

}

@test fn testEncodeSltiu() throws (testing::TestError) {

    let enc = encode::sltiu(super::reg(1), super::reg(2), 100);

    try expectEncoding(enc, 0x06413093);

}

@test fn testEncodeXori() throws (testing::TestError) {

    let enc = encode::xori(super::reg(1), super::reg(2), 0xFF);

    try expectEncoding(enc, 0x0FF14093);

}

@test fn testEncodeOri() throws (testing::TestError) {

    let enc = encode::ori(super::reg(1), super::reg(2), 0xFF);

    try expectEncoding(enc, 0x0FF16093);

}

@test fn testEncodeAndi() throws (testing::TestError) {

    let enc = encode::andi(super::reg(1), super::reg(2), 0xFF);

    try expectEncoding(enc, 0x0FF17093);

}

@test fn testEncodeSlli() throws (testing::TestError) {

    let enc = encode::slli(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x00511093);

}

@test fn testEncodeSrli() throws (testing::TestError) {

    let enc = encode::srli(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x00515093);

}

@test fn testEncodeSrai() throws (testing::TestError) {

    let enc = encode::srai(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x40515093);

}

//////////////////

// Load tests   //

//////////////////

@test fn testEncodeLb() throws (testing::TestError) {

    let enc = encode::lb(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00810083);

}

@test fn testEncodeLh() throws (testing::TestError) {

    let enc = encode::lh(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00811083);

}

@test fn testEncodeLw() throws (testing::TestError) {

    let enc = encode::lw(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00812083);

}

@test fn testEncodeLbu() throws (testing::TestError) {

    let enc = encode::lbu(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00814083);

}

@test fn testEncodeLhu() throws (testing::TestError) {

    let enc = encode::lhu(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00815083);

}

@test fn testEncodeLwu() throws (testing::TestError) {

    let enc = encode::lwu(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00816083);

}

@test fn testEncodeLd() throws (testing::TestError) {

    let enc = encode::ld(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00813083);

}

//////////////////

// Store tests  //

//////////////////

@test fn testEncodeSb() throws (testing::TestError) {

    let enc = encode::sb(super::reg(3), super::reg(2), 8);

    try expectEncoding(enc, 0x00310423);

}

@test fn testEncodeSh() throws (testing::TestError) {

    let enc = encode::sh(super::reg(3), super::reg(2), 8);

    try expectEncoding(enc, 0x00311423);

}

@test fn testEncodeSw() throws (testing::TestError) {

    let enc = encode::sw(super::reg(3), super::reg(2), 8);

    try expectEncoding(enc, 0x00312423);

}

@test fn testEncodeSd() throws (testing::TestError) {

    let enc = encode::sd(super::reg(3), super::reg(2), 8);

    try expectEncoding(enc, 0x00313423);

}

@test fn testEncodeSwNegativeOffset() throws (testing::TestError) {

    let enc = encode::sw(super::reg(3), super::reg(2), -4);

    try expectEncoding(enc, 0xFE312E23);

}

//////////////////

// Branch tests //

//////////////////

@test fn testEncodeBeq() throws (testing::TestError) {

    let enc = encode::beq(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00208463);

}

@test fn testEncodeBne() throws (testing::TestError) {

    let enc = encode::bne(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00209463);

}

@test fn testEncodeBlt() throws (testing::TestError) {

    let enc = encode::blt(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x0020C463);

}

@test fn testEncodeBge() throws (testing::TestError) {

    let enc = encode::bge(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x0020D463);

}

@test fn testEncodeBltu() throws (testing::TestError) {

    let enc = encode::bltu(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x0020E463);

}

@test fn testEncodeBgeu() throws (testing::TestError) {

    let enc = encode::bgeu(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x0020F463);

}

@test fn testEncodeBranchNegative() throws (testing::TestError) {

    let enc = encode::beq(super::reg(1), super::reg(2), -8);

    try expectEncoding(enc, 0xFE208CE3);

}

//////////////////

// Jump tests   //

//////////////////

@test fn testEncodeJal() throws (testing::TestError) {

    let enc = encode::jal(super::reg(1), 8);

    try expectEncoding(enc, 0x008000EF);

}

@test fn testEncodeJalr() throws (testing::TestError) {

    let enc = encode::jalr(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x008100E7);

}

///////////////////////////

// Upper immediate tests //

///////////////////////////

@test fn testEncodeLui() throws (testing::TestError) {

    let enc = encode::lui(super::reg(1), 0x12345);

    try expectEncoding(enc, 0x123450B7);

}

@test fn testEncodeAuipc() throws (testing::TestError) {

    let enc = encode::auipc(super::reg(1), 0x12345);

    try expectEncoding(enc, 0x12345097);

}

//////////////////

// System tests //

//////////////////

@test fn testEncodeEcall() throws (testing::TestError) {

    let enc = encode::ecall();

    try expectEncoding(enc, 0x00000073);

}

@test fn testEncodeEbreak() throws (testing::TestError) {

    let enc = encode::ebreak();

    try expectEncoding(enc, 0x00100073);

}

/////////////////////

// M extension tests

/////////////////////

@test fn testEncodeMul() throws (testing::TestError) {

    let enc = encode::mul(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023100B3);

}

@test fn testEncodeMulh() throws (testing::TestError) {

    let enc = encode::mulh(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023110B3);

}

@test fn testEncodeMulhsu() throws (testing::TestError) {

    let enc = encode::mulhsu(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023120B3);

}

@test fn testEncodeMulhu() throws (testing::TestError) {

    let enc = encode::mulhu(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023130B3);

}

@test fn testEncodeDiv() throws (testing::TestError) {

    let enc = encode::div(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023140B3);

}

@test fn testEncodeDivu() throws (testing::TestError) {

    let enc = encode::divu(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023150B3);

}

@test fn testEncodeRem() throws (testing::TestError) {

    let enc = encode::rem(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023160B3);

}

@test fn testEncodeRemu() throws (testing::TestError) {

    let enc = encode::remu(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023170B3);

}

////////////////////////////

// RV64 Word operation tests

////////////////////////////

@test fn testEncodeAddiw() throws (testing::TestError) {

    let enc = encode::addiw(super::reg(1), super::reg(2), 42);

    try expectEncoding(enc, 0x02A1009B);

}

@test fn testEncodeSlliw() throws (testing::TestError) {

    let enc = encode::slliw(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x0051109B);

}

@test fn testEncodeSrliw() throws (testing::TestError) {

    let enc = encode::srliw(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x0051509B);

}

@test fn testEncodeSraiw() throws (testing::TestError) {

    let enc = encode::sraiw(super::reg(1), super::reg(2), 5);

    try expectEncoding(enc, 0x4051509B);

}

@test fn testEncodeAddw() throws (testing::TestError) {

    let enc = encode::addw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003100BB);

}

@test fn testEncodeSubw() throws (testing::TestError) {

    let enc = encode::subw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x403100BB);

}

@test fn testEncodeSllw() throws (testing::TestError) {

    let enc = encode::sllw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003110BB);

}

@test fn testEncodeSrlw() throws (testing::TestError) {

    let enc = encode::srlw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x003150BB);

}

@test fn testEncodeSraw() throws (testing::TestError) {

    let enc = encode::sraw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x403150BB);

}

@test fn testEncodeMulw() throws (testing::TestError) {

    let enc = encode::mulw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023100BB);

}

@test fn testEncodeDivw() throws (testing::TestError) {

    let enc = encode::divw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023140BB);

}

@test fn testEncodeDivuw() throws (testing::TestError) {

    let enc = encode::divuw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023150BB);

}

@test fn testEncodeRemw() throws (testing::TestError) {

    let enc = encode::remw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023160BB);

}

@test fn testEncodeRemuw() throws (testing::TestError) {

    let enc = encode::remuw(super::reg(1), super::reg(2), super::reg(3));

    try expectEncoding(enc, 0x023170BB);

}

/////////////////////////////////

// RV64 6-bit shift amount tests

/////////////////////////////////

@test fn testEncodeSlli64() throws (testing::TestError) {

    let enc = encode::slli(super::reg(1), super::reg(2), 32);

    try expectEncoding(enc, 0x02011093);

}

@test fn testEncodeSrli64() throws (testing::TestError) {

    let enc = encode::srli(super::reg(1), super::reg(2), 32);

    try expectEncoding(enc, 0x02015093);

}

@test fn testEncodeSrai64() throws (testing::TestError) {

    let enc = encode::srai(super::reg(1), super::reg(2), 32);

    try expectEncoding(enc, 0x42015093);

}

///////////////////////////

// Pseudo-instruction tests

///////////////////////////

@test fn testEncodeNop() throws (testing::TestError) {

    let enc = encode::nop();

    try expectEncoding(enc, 0x00000013);

}

@test fn testEncodeMv() throws (testing::TestError) {

    let enc = encode::mv(super::reg(1), super::reg(2));

    try expectEncoding(enc, 0x00010093);

}

@test fn testEncodeNot() throws (testing::TestError) {

    let enc = encode::not_(super::reg(1), super::reg(2));

    try expectEncoding(enc, 0xFFF14093);

}

@test fn testEncodeNeg() throws (testing::TestError) {

    let enc = encode::neg(super::reg(1), super::reg(2));

    try expectEncoding(enc, 0x402000B3);

}

@test fn testEncodeRet() throws (testing::TestError) {

    let enc = encode::ret();

    try expectEncoding(enc, 0x00008067);

}

@test fn testEncodeJ() throws (testing::TestError) {

    let enc = encode::j(8);

    try expectEncoding(enc, 0x0080006F);

}

@test fn testEncodeBle() throws (testing::TestError) {

    let enc = encode::ble(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00115463);

}

@test fn testEncodeBgt() throws (testing::TestError) {

    let enc = encode::bgt(super::reg(1), super::reg(2), 8);

    try expectEncoding(enc, 0x00114463);

}

@test fn testEncodeSeqz() throws (testing::TestError) {

    let enc = encode::seqz(super::reg(1), super::reg(2));

    try expectEncoding(enc, 0x00113093);

}

@test fn testEncodeSnez() throws (testing::TestError) {

    let enc = encode::snez(super::reg(1), super::reg(2));

    try expectEncoding(enc, 0x002030B3);

}

@test fn testEncodeBeqz() throws (testing::TestError) {

    let enc = encode::beqz(super::reg(1), 8);

    try expectEncoding(enc, 0x00008463);

}

@test fn testEncodeBnez() throws (testing::TestError) {

    let enc = encode::bnez(super::reg(1), 8);

    try expectEncoding(enc, 0x00009463);

}

@test fn testEncodeCall() throws (testing::TestError) {

    let enc = encode::call(8);

    try expectEncoding(enc, 0x008000EF);

}

/////////////////////////////

// Validation helper tests //

/////////////////////////////

@test fn testIsSmallImm() throws (testing::TestError) {

    try testing::expect(encode::isSmallImm(0));

    try testing::expect(encode::isSmallImm(2047));

    try testing::expect(encode::isSmallImm(-2048));

    try testing::expect(encode::isSmallImm(-1));

    try testing::expectNot(encode::isSmallImm(2048));

    try testing::expectNot(encode::isSmallImm(-2049));

}

@test fn testIsBranchImm() throws (testing::TestError) {

    try testing::expect(encode::isBranchImm(0));

    try testing::expect(encode::isBranchImm(8));

    try testing::expect(encode::isBranchImm(-8));

    try testing::expect(encode::isBranchImm(4094));

    try testing::expect(encode::isBranchImm(-4096));

    try testing::expectNot(encode::isBranchImm(1));     // Must be even

    try testing::expectNot(encode::isBranchImm(4096));  // Out of range

}

@test fn testIsJumpImm() throws (testing::TestError) {

    try testing::expect(encode::isJumpImm(0));

    try testing::expect(encode::isJumpImm(8));

    try testing::expect(encode::isJumpImm(-8));

    try testing::expect(encode::isJumpImm(1048574));    // Max positive even

    try testing::expect(encode::isJumpImm(-1048576));   // Min negative

    try testing::expectNot(encode::isJumpImm(1));       // Must be even

    try testing::expectNot(encode::isJumpImm(1048576)); // Out of range

}