aver-lang 0.14.2

// Aver VM bytecode opcodes.
//
// Stack-based: operands are pushed/popped from the operand stack.
// Variable-width encoding: opcode (1 byte) + operands (0-3 bytes).

// -- Stack / locals ----------------------------------------------------------

/// No-op, used as padding after superinstruction fusion.
pub const NOP: u8 = 0x00;

/// Push `stack[bp + slot]` onto the operand stack.
pub const LOAD_LOCAL: u8 = 0x01; // slot:u8

/// Push `stack[bp + slot]` and clear the slot (move semantics).
/// Used for last-use variables: caller releases sole ownership so
/// callees and builtins see refcount=1 and can mutate in-place.
pub const MOVE_LOCAL: u8 = 0x48; // slot:u8

/// Pop top and store into `stack[bp + slot]`.
pub const STORE_LOCAL: u8 = 0x02; // slot:u8

/// Push `constants[idx]` onto the operand stack.
pub const LOAD_CONST: u8 = 0x03; // idx:u16

/// Push `globals[idx]` onto the operand stack.
pub const LOAD_GLOBAL: u8 = 0x04; // idx:u16

/// Pop top and store into `globals[idx]`.
pub const STORE_GLOBAL: u8 = 0x0A; // idx:u16

/// Discard the top value.
pub const POP: u8 = 0x05;

/// Duplicate the top value.
pub const DUP: u8 = 0x06;

/// Push `NanValue::UNIT`.
pub const LOAD_UNIT: u8 = 0x07;

/// Push `NanValue::TRUE`.
pub const LOAD_TRUE: u8 = 0x08;

/// Push `NanValue::FALSE`.
pub const LOAD_FALSE: u8 = 0x09;

// -- Arithmetic --------------------------------------------------------------

/// Pop b, pop a, push a + b.
pub const ADD: u8 = 0x10;

/// Pop b, pop a, push a - b.
pub const SUB: u8 = 0x11;

/// Pop b, pop a, push a * b.
pub const MUL: u8 = 0x12;

/// Pop b, pop a, push a / b.
pub const DIV: u8 = 0x13;

/// Pop b, pop a, push a % b.
pub const MOD: u8 = 0x14;

/// Pop a, push -a.
pub const NEG: u8 = 0x15;

/// Pop a, push !a (boolean not).
pub const NOT: u8 = 0x16;

// -- Comparison --------------------------------------------------------------

/// Pop b, pop a, push a == b.
pub const EQ: u8 = 0x20;

/// Pop b, pop a, push a < b.
pub const LT: u8 = 0x21;

/// Pop b, pop a, push a > b.
pub const GT: u8 = 0x22;

// -- String ------------------------------------------------------------------

/// Pop b, pop a, push str(a) ++ str(b).
pub const CONCAT: u8 = 0x28;

// -- Control flow ------------------------------------------------------------

/// Unconditional relative jump: ip += offset.
pub const JUMP: u8 = 0x30; // offset:i16

/// Pop top, if falsy: ip += offset.
pub const JUMP_IF_FALSE: u8 = 0x31; // offset:i16

// -- Calls -------------------------------------------------------------------

/// Call a known function by id. Args already on stack.
pub const CALL_KNOWN: u8 = 0x40; // fn_id:u16, argc:u8

/// Call a function value on the stack (under args).
pub const CALL_VALUE: u8 = 0x41; // argc:u8

/// Call a builtin service function.
pub const CALL_BUILTIN: u8 = 0x42; // symbol_id:u32, argc:u8

/// Like CALL_BUILTIN but with owned-argument bitmask from reuse analysis.
/// Builtins receiving owned args can mutate in-place instead of cloning.
pub const CALL_BUILTIN_OWNED: u8 = 0x46; // symbol_id:u32, argc:u8, owned:u8

/// Like CALL_KNOWN but with owned-argument bitmask from reuse analysis.
pub const CALL_KNOWN_OWNED: u8 = 0x47; // fn_id:u16, argc:u8, owned:u8

/// Self tail-call: reuse current frame with new args.
pub const TAIL_CALL_SELF: u8 = 0x43; // argc:u8

/// Mutual tail-call to a known function: reuse frame, switch target.
pub const TAIL_CALL_KNOWN: u8 = 0x44; // fn_id:u16, argc:u8

/// Return top of stack to caller.
pub const RETURN: u8 = 0x50;

// -- Structured values -------------------------------------------------------

/// Push Nil (empty cons list).
pub const LIST_NIL: u8 = 0x60;

/// Pop tail, pop head, push Cons(head, tail).
pub const LIST_CONS: u8 = 0x61;

/// Pop `count` items, build cons list from them (first item = head), push list.
pub const LIST_NEW: u8 = 0x62; // count:u8

/// Pop `count` field values, push a new record with `type_id`.
pub const RECORD_NEW: u8 = 0x63; // type_id:u16, count:u8

/// Pop record, push `fields[field_idx]` (compile-time resolved index).
pub const RECORD_GET: u8 = 0x64; // field_idx:u8

/// Pop record, lookup field by interned field symbol, push value.
pub const RECORD_GET_NAMED: u8 = 0x67; // field_symbol_id:u32

/// Pop `count` field values, push a new variant.
pub const VARIANT_NEW: u8 = 0x65; // type_id:u16, variant_id:u16, count:u8

/// Pop value, push wrapped value. kind: 0=Ok, 1=Err, 2=Some.
pub const WRAP: u8 = 0x66; // kind:u8

/// Pop `count` items, build a tuple from them, push tuple.
pub const TUPLE_NEW: u8 = 0x68; // count:u8

/// Parallel function calls for independent products (?! / !).
/// Pops N callable values plus their args from the stack, dispatches them via
/// the same callable resolution rules as CALL_VALUE, then builds the result tuple.
/// Enters/exits replay group around parallel dispatch.
///
/// Encoding: CALL_PAR count:u8 unwrap:u8 [argc:u8 × count]
/// unwrap=1 (?!): unwrap each Result, propagate first Err.
/// unwrap=0 (!): return raw tuple.
pub const CALL_PAR: u8 = 0x86;

/// Update selected fields on a record, preserving the rest from the base value.
/// Stack: [..., base_record, update_0, ..., update_n-1] -> [..., updated_record]
pub const RECORD_UPDATE: u8 = 0x69; // type_id:u16, count:u8, field_idx[count]:u8

/// Propagate `Result.Err` to caller or unwrap `Result.Ok` in place.
pub const PROPAGATE_ERR: u8 = 0x6A;

/// Pop list, push its length as Int.
pub const LIST_LEN: u8 = 0x6B;

// 0x6C and 0x6D were LIST_GET and LIST_APPEND — removed.

/// Pop list, pop value, push prepended list.
pub const LIST_PREPEND: u8 = 0x6E;

// 0x6F was LIST_GET_MATCH — removed.

// -- Pattern matching --------------------------------------------------------

/// Peek top: if NaN tag != expected, ip += fail_offset.
pub const MATCH_TAG: u8 = 0x70; // expected_tag:u8, fail_offset:i16

/// Peek top (must be variant): if variant_id != expected, ip += fail_offset.
pub const MATCH_VARIANT: u8 = 0x71; // ctor_id:u16, fail_offset:i16

/// Peek top: if not wrapper of `kind`, ip += fail_offset.
/// If matches, replace top with inner value (unwrap in-place).
/// kind: 0=Ok, 1=Err, 2=Some.
pub const MATCH_UNWRAP: u8 = 0x72; // kind:u8, fail_offset:i16

/// Peek top: if not Nil, ip += fail_offset.
pub const MATCH_NIL: u8 = 0x73; // fail_offset:i16

/// Peek top: if Nil (not a cons), ip += fail_offset.
pub const MATCH_CONS: u8 = 0x74; // fail_offset:i16

/// Pop cons cell, push tail then push head.
pub const LIST_HEAD_TAIL: u8 = 0x75;

/// Peek top (record/variant), push `fields[field_idx]` (non-destructive).
pub const EXTRACT_FIELD: u8 = 0x76; // field_idx:u8

/// Peek top: if not a tuple of `count` items, ip += fail_offset.
pub const MATCH_TUPLE: u8 = 0x78; // count:u8, fail_offset:i16

/// Peek top tuple, push `items[item_idx]` (non-destructive).
pub const EXTRACT_TUPLE_ITEM: u8 = 0x79; // item_idx:u8

/// Non-exhaustive match error at source line.
pub const MATCH_FAIL: u8 = 0x77; // line:u16

/// Unified prefix/exact dispatch on NanValue bits.
///
/// Encoding:
///   MATCH_DISPATCH count:u8 default_offset:i16
///     [(kind:u8, expected:u64, offset:i16) × count]
///
/// kind=0: exact match  — `val.bits() == expected`
/// kind=1: tag match    — `(val.bits() & TAG_MASK_FULL) == expected`
///   where TAG_MASK_FULL = 0xFFFF_C000_0000_0000 (QNAN 14 bits + tag 4 bits)
///
/// Pops subject. Scans entries in order; first match wins → ip += offset.
/// No match → ip += default_offset.
/// All offsets are relative to the end of the full instruction.
pub const MATCH_DISPATCH: u8 = 0x7A;

/// Like MATCH_DISPATCH but every entry carries an inline result instead
/// of a jump offset.  When an entry matches, the result is pushed directly
/// onto the stack and the match body is skipped entirely.
///
/// Encoding:
///   MATCH_DISPATCH_CONST count:u8 default_offset:i16
///     [(kind:u8, expected:u64, result:u64) × count]
///
/// Hit → pop subject, push result NanValue.
/// Miss → pop subject, ip += default_offset (execute default arm body).
///
/// Emitted when ALL dispatchable arms have constant bodies (literals).
pub const MATCH_DISPATCH_CONST: u8 = 0x7B;

/// Tail-call self for thin frames: no arena finalization needed.
/// The compiler emits this instead of TAIL_CALL_SELF when the function
/// is known to be "thin" (no heap allocations within the frame).
/// Skips finalize_frame_locals_for_tail_call entirely — just copies
/// args in-place and resets ip.
pub const TAIL_CALL_SELF_THIN: u8 = 0x45; // argc:u8

/// Inline Option.withDefault: pop default, pop option → push inner or default.
/// Stack: [option, default] → [result]
/// If option is Some → push unwrapped inner value.
/// If option is None → push default.
pub const UNWRAP_OR: u8 = 0x7C;

/// Inline Result.withDefault: pop default, pop result → push inner or default.
/// Stack: [result, default] → [value]
/// If result is Ok → push unwrapped inner value.
/// If result is Err → push default.
pub const UNWRAP_RESULT_OR: u8 = 0x7D;

/// Frameless call to a leaf+thin+args-only function.
/// No CallFrame is pushed — just saves (fn_id, ip) in the dispatch loop,
/// sets bp to the args already on stack, and jumps to the target.
/// On RETURN, restores the caller's state directly.
/// Format: fn_id:u16, argc:u8 (same as CALL_KNOWN).
pub const CALL_LEAF: u8 = 0x7E;

// ─── Superinstructions ──────────────────────────────────────

/// Push two locals in one dispatch. Format: slot_a:u8, slot_b:u8.
pub const LOAD_LOCAL_2: u8 = 0x80;

/// Push one local + one constant in one dispatch. Format: slot:u8, const_idx:u16.
pub const LOAD_LOCAL_CONST: u8 = 0x81;

/// Inline Vector.get: pop index, pop vector → push Option (Some/None).
/// Stack: [vector, index] → [option]
pub const VECTOR_GET: u8 = 0x82;

/// Fused Vector.get + Option.withDefault: pop default, pop index, pop vector → push value.
/// Stack: [vector, index, default] → [value]
/// Combines CALL_BUILTIN(Vector.get) + LOAD_CONST + UNWRAP_OR into one opcode.
pub const VECTOR_GET_OR: u8 = 0x83;

/// Inline Vector.set: pop value, pop index, pop vector → push Option<Vector>.
/// Stack: [vector, index, value] → [option_vector]
pub const VECTOR_SET: u8 = 0x84;

/// Fused Vector.set + Option.withDefault(vec): pop value, pop index, pop vector → push vector.
/// Stack: [vector, index, value] → [vector]
pub const VECTOR_SET_OR_KEEP: u8 = 0x85;

/// Opcode name for debug/disassembly.
pub fn opcode_name(op: u8) -> &'static str {
    match op {
        LOAD_LOCAL => "LOAD_LOCAL",
        MOVE_LOCAL => "MOVE_LOCAL",
        STORE_LOCAL => "STORE_LOCAL",
        LOAD_CONST => "LOAD_CONST",
        LOAD_GLOBAL => "LOAD_GLOBAL",
        POP => "POP",
        DUP => "DUP",
        LOAD_UNIT => "LOAD_UNIT",
        LOAD_TRUE => "LOAD_TRUE",
        LOAD_FALSE => "LOAD_FALSE",
        ADD => "ADD",
        SUB => "SUB",
        MUL => "MUL",
        DIV => "DIV",
        MOD => "MOD",
        NEG => "NEG",
        NOT => "NOT",
        EQ => "EQ",
        LT => "LT",
        GT => "GT",
        CONCAT => "CONCAT",
        JUMP => "JUMP",
        JUMP_IF_FALSE => "JUMP_IF_FALSE",
        CALL_KNOWN => "CALL_KNOWN",
        CALL_VALUE => "CALL_VALUE",
        CALL_BUILTIN => "CALL_BUILTIN",
        CALL_BUILTIN_OWNED => "CALL_BUILTIN_OWNED",
        CALL_KNOWN_OWNED => "CALL_KNOWN_OWNED",
        TAIL_CALL_SELF => "TAIL_CALL_SELF",
        TAIL_CALL_KNOWN => "TAIL_CALL_KNOWN",
        RETURN => "RETURN",
        LIST_NIL => "LIST_NIL",
        LIST_CONS => "LIST_CONS",
        LIST_NEW => "LIST_NEW",
        RECORD_NEW => "RECORD_NEW",
        STORE_GLOBAL => "STORE_GLOBAL",
        RECORD_GET => "RECORD_GET",
        RECORD_GET_NAMED => "RECORD_GET_NAMED",
        VARIANT_NEW => "VARIANT_NEW",
        WRAP => "WRAP",
        TUPLE_NEW => "TUPLE_NEW",
        RECORD_UPDATE => "RECORD_UPDATE",
        PROPAGATE_ERR => "PROPAGATE_ERR",
        LIST_LEN => "LIST_LEN",
        LIST_PREPEND => "LIST_PREPEND",
        MATCH_TAG => "MATCH_TAG",
        MATCH_VARIANT => "MATCH_VARIANT",
        MATCH_UNWRAP => "MATCH_UNWRAP",
        MATCH_NIL => "MATCH_NIL",
        MATCH_CONS => "MATCH_CONS",
        LIST_HEAD_TAIL => "LIST_HEAD_TAIL",
        EXTRACT_FIELD => "EXTRACT_FIELD",
        MATCH_TUPLE => "MATCH_TUPLE",
        EXTRACT_TUPLE_ITEM => "EXTRACT_TUPLE_ITEM",
        MATCH_FAIL => "MATCH_FAIL",
        MATCH_DISPATCH => "MATCH_DISPATCH",
        MATCH_DISPATCH_CONST => "MATCH_DISPATCH_CONST",
        TAIL_CALL_SELF_THIN => "TAIL_CALL_SELF_THIN",
        UNWRAP_OR => "UNWRAP_OR",
        UNWRAP_RESULT_OR => "UNWRAP_RESULT_OR",
        CALL_LEAF => "CALL_LEAF",
        LOAD_LOCAL_2 => "LOAD_LOCAL_2",
        LOAD_LOCAL_CONST => "LOAD_LOCAL_CONST",
        VECTOR_GET => "VECTOR_GET",
        VECTOR_GET_OR => "VECTOR_GET_OR",
        VECTOR_SET => "VECTOR_SET",
        VECTOR_SET_OR_KEEP => "VECTOR_SET_OR_KEEP",
        CALL_PAR => "CALL_PAR",
        NOP => "NOP",
        _ => "UNKNOWN",
    }
}

/// Operand byte width after the opcode byte. Single source of truth —
/// all bytecode traversal functions must use this.
pub fn opcode_operand_width(op: u8, code: &[u8], ip: usize) -> usize {
    match op {
        // 0-byte (stack-only)
        POP | DUP | LOAD_UNIT | LOAD_TRUE | LOAD_FALSE | ADD | SUB | MUL | DIV | MOD | NEG
        | NOT | EQ | LT | GT | RETURN | PROPAGATE_ERR | LIST_HEAD_TAIL | LIST_NIL | LIST_CONS
        | LIST_LEN | LIST_PREPEND | UNWRAP_OR | UNWRAP_RESULT_OR | CONCAT | VECTOR_GET
        | VECTOR_SET | NOP => 0,

        // 1-byte
        LOAD_LOCAL | MOVE_LOCAL | STORE_LOCAL | CALL_VALUE | RECORD_GET | EXTRACT_FIELD
        | EXTRACT_TUPLE_ITEM | LIST_NEW | WRAP | TUPLE_NEW | TAIL_CALL_SELF
        | TAIL_CALL_SELF_THIN | VECTOR_SET_OR_KEEP => 1,

        // 2-byte (u16 or u8+u8)
        LOAD_CONST | LOAD_GLOBAL | STORE_GLOBAL | JUMP | JUMP_IF_FALSE | MATCH_FAIL | MATCH_NIL
        | MATCH_CONS | LOAD_LOCAL_2 | VECTOR_GET_OR => 2,

        // 3-byte
        CALL_KNOWN | CALL_LEAF | MATCH_TAG | MATCH_UNWRAP | MATCH_TUPLE | RECORD_NEW
        | LOAD_LOCAL_CONST => 3,

        // 4-byte
        CALL_KNOWN_OWNED => 4, // fn_id:u16 + argc:u8 + owned:u8

        // 4-byte
        MATCH_VARIANT | RECORD_GET_NAMED => 4,

        // 5-byte
        CALL_BUILTIN | VARIANT_NEW => 5,

        // 6-byte
        CALL_BUILTIN_OWNED => 6, // symbol_id:u32 + argc:u8 + owned:u8

        // Variable-length
        MATCH_DISPATCH | MATCH_DISPATCH_CONST if ip < code.len() => {
            let count = code[ip] as usize;
            let entry_size = if op == MATCH_DISPATCH { 11 } else { 17 };
            3 + count * entry_size
        }
        RECORD_UPDATE if ip + 2 < code.len() => 3 + code[ip + 2] as usize,
        // CALL_PAR count:u8 unwrap:u8 [argc:u8 × count]
        CALL_PAR if ip < code.len() => {
            let count = code[ip] as usize;
            2 + count
        }
        _ => 0,
    }
}