191. Instrucción rti

implementar el comportamiento de RTI.

Lección 191 de 356 · tests/chapter_01_cpu/test_191_instruction_rti.py

En este paso, modifica únicamente `emulator/cpu/instructions.py añadiendo rti(cpu)`. Requisito previo: el paso 188 introdujo las API necesarias de interrupciones y del flag Break.

Por qué existe este paso

La entrada de una interrupción deja el estado, el byte bajo de retorno del PC y el byte alto de retorno del PC en las tres siguientes posiciones de la pila. RTI debe extraer esos bytes en ese orden LIFO y restaurar el PC exacto; a diferencia de RTS, no debe sumar uno.

Implementación sugerida

cpu.s = (cpu.s + 1) & 0xFF
flags = cpu.bus.read(0x0100 | cpu.s)
cpu.p = flags & 0b1100_1111

cpu.s = (cpu.s + 1) & 0xFF
low = cpu.bus.read(0x0100 | cpu.s)

cpu.s = (cpu.s + 1) & 0xFF
high = cpu.bus.read(0x0100 | cpu.s)

cpu.pc = (high << 8) | low

Coloca esas sentencias en `def rti(cpu: CPU)`.

Invariantes: incrementa el S de 8 bits antes de cada lectura; lee solo la página de pila $0100; sustituye P tras enmascarar los bits 4 y 5; extrae primero el byte bajo y después el alto; incrementa S tres veces; deja el PC restaurado sin incrementar.

Concepto erróneo: RTI no es un RTS para interrupciones. Aplicar el `+ 1` final de RTS hace que se retorne a la instrucción equivocada.

Fuera de alcance: la importación/registro del opcode en $40 corresponde al paso 192. El comportamiento de NMI corresponde a pasos posteriores y no debe añadirse aquí.

Ejecutar esta lección

uv run pytest tests/chapter_01_cpu/test_191_instruction_rti.py -v

Implementación de ejemplo

Implementación sugerida

cpu.s = (cpu.s + 1) & 0xFF
flags = cpu.bus.read(0x0100 | cpu.s)
cpu.p = flags & 0b1100_1111

cpu.s = (cpu.s + 1) & 0xFF
low = cpu.bus.read(0x0100 | cpu.s)

cpu.s = (cpu.s + 1) & 0xFF
high = cpu.bus.read(0x0100 | cpu.s)

cpu.pc = (high << 8) | low

Ver código del testtest_191_instruction_rti.py

from emulator.cpu.instructions import rti
from tests.helpers import make_cpu


CARRY_FLAG = 1 << 0
ZERO_FLAG = 1 << 1
INTERRUPT_DISABLE_FLAG = 1 << 2
BREAK_FLAG = 1 << 4
ONE_FLAG = 1 << 5
OVERFLOW_FLAG = 1 << 6
NEGATIVE_FLAG = 1 << 7
STACK_BASE = 0x0100


def test_rti_restores_program_counter_from_stack_without_adding_one():
    """
    Objective:
    RTI restores the exact PC from the stack.

    If the stack contains $1234, PC becomes $1234, not $1235.
    """
    cpu = make_cpu()
    cpu.s = 0xFA
    cpu.bus.write(STACK_BASE | 0xFB, 0x00)
    cpu.bus.write(STACK_BASE | 0xFC, 0x34)
    cpu.bus.write(STACK_BASE | 0xFD, 0x12)

    rti(cpu)

    assert cpu.pc == 0x1234


def test_rti_pulls_status_then_pc_low_then_pc_high():
    """
    Objective:
    RTI must pull stack bytes in interrupt-return order:

        status -> PC low -> PC high

    This is the reverse of what BRK/interrupt entry pushed.
    """
    cpu = make_cpu()
    cpu.s = 0xFA
    cpu.bus.write(STACK_BASE | 0xFB, CARRY_FLAG | NEGATIVE_FLAG)
    cpu.bus.write(STACK_BASE | 0xFC, 0xCD)
    cpu.bus.write(STACK_BASE | 0xFD, 0xAB)

    rti(cpu)

    assert cpu.p == (CARRY_FLAG | NEGATIVE_FLAG)
    assert cpu.pc == 0xABCD


def test_rti_increments_stack_pointer_three_times():
    """Objective: RTI pulls status, PC low, and PC high, so S increases by 3."""
    cpu = make_cpu()
    cpu.s = 0xFA
    cpu.bus.write(STACK_BASE | 0xFB, 0x00)
    cpu.bus.write(STACK_BASE | 0xFC, 0x34)
    cpu.bus.write(STACK_BASE | 0xFD, 0x12)

    rti(cpu)

    assert cpu.s == 0xFD


def test_rti_restores_status_flags_from_stack():
    """
    Objective:
    RTI restores saved processor status flags from the stack.

    These flags affect later branches and arithmetic, so RTI must not leave the
    interrupt handler's temporary flags behind.
    """
    cpu = make_cpu()
    cpu.s = 0xFA
    saved_flags = CARRY_FLAG | ZERO_FLAG | INTERRUPT_DISABLE_FLAG | OVERFLOW_FLAG | NEGATIVE_FLAG
    cpu.bus.write(STACK_BASE | 0xFB, saved_flags)
    cpu.bus.write(STACK_BASE | 0xFC, 0x34)
    cpu.bus.write(STACK_BASE | 0xFD, 0x12)

    rti(cpu)

    assert cpu.p == saved_flags


def test_rti_clears_break_and_unused_status_bits_from_pulled_status():
    """
    Objective:
    In this emulator model, status bits 4 and 5 are not kept as persistent CPU
    state after RTI.

    Why:
    BRK may push a status byte with Break set, but Break is metadata in the
    saved stack byte, not a normal long-lived CPU flag here.
    """
    cpu = make_cpu()
    cpu.s = 0xFA
    saved_flags_with_break_and_unused = 0b0011_0000 | CARRY_FLAG | NEGATIVE_FLAG
    cpu.bus.write(STACK_BASE | 0xFB, saved_flags_with_break_and_unused)
    cpu.bus.write(STACK_BASE | 0xFC, 0x34)
    cpu.bus.write(STACK_BASE | 0xFD, 0x12)

    rti(cpu)

    assert (cpu.p & BREAK_FLAG) == 0
    assert (cpu.p & ONE_FLAG) == 0
    assert cpu.p == (CARRY_FLAG | NEGATIVE_FLAG)


def test_rti_stack_pointer_wraps_to_8_bits():
    """Objective: S is an 8-bit stack pointer and wraps while pulling bytes."""
    cpu = make_cpu()
    cpu.s = 0xFE
    cpu.bus.write(STACK_BASE | 0xFF, CARRY_FLAG)
    cpu.bus.write(STACK_BASE | 0x00, 0x78)
    cpu.bus.write(STACK_BASE | 0x01, 0x56)

    rti(cpu)

    assert cpu.p == CARRY_FLAG
    assert cpu.pc == 0x5678
    assert cpu.s == 0x01

Funciones de test (6)

test_rti_restores_program_counter_from_stack_without_adding_one
test_rti_pulls_status_then_pc_low_then_pc_high
test_rti_increments_stack_pointer_three_times
test_rti_restores_status_flags_from_stack
test_rti_clears_break_and_unused_status_bits_from_pulled_status
test_rti_stack_pointer_wraps_to_8_bits