problame/rc64

C64 emulator / Virtual Systems Lab @ KIT ITEC OS Group / https://os.itec.kit.edu/3727.php

This project was jointly developed by:

• Joshua Bachmeier
• Christian Schwarz

---

Introduction

Have a look at our final presentation for an introduction.

Highlights

• MOS6510 implementation
  • passes Klaus Dormann's 6502 functional test suite in no_decimal=1 mode
    • just run cargo test --release
  • just enough BCD-mode support for ADC to make Pacman happy
• VIC20 implementation
  • Standard text mode
  • Multicolor text mode
  • Standart & Multicolor Bitmap mode
  • Sprite support
    • only sprite-sprite collisions (sprite-data collisions in headless-chicken mode)
    • collisions cannot be cleared through reads, only through writes
  • No badline support
• Built-in Monitor
  • PC and EA breakpoints
  • Raster-IRQ breakpoints
  • Raster-beam visualization
  • MOS and VIC state inspection
  • Memory inspection & manipulation
  • Instruction tracing
• PRG Autostarter - just pass the path to the PRG you want to start on the command line
• Cycle-accurate instruction execution duration
  • architectural behavior of each instruction applied in first cycle, though
• Joystick Support - try it in Boulder or with ./rc64/prg_tests/joy.prg
  • Joystick configuration --joystick{1,2}={none,numpad,wasd}
• Rust Memory-Safety

What Works And What Doesn't

• Kernal Boot-up & BASIC prompt input
• Start and run BASIC programs in ./prg_tests (you have to make -C prg_tests them)
• Raster IRQ demos in ./asm_tests (you have to make -C asm_tests them)
• Sprite demo prg_tests/sprite.prg (you have to make -C prg_tests)
• Boulder PRG with --joystick1
• Pacman PRG with --joystick2
• [-] Ninja PRG (partially)
  • Only welcome screen works, not actual game

Build Instructions

Linux Binaries

cargo build --release
stat target/release/rc64

Windows Binaries (cross-built from Linux using cross)

cargo install cross
sudo setfacl -m u:$(id -u):rwx /var/run/docker.sock
cross build --release --target 86_64-pc-windows-gnu
stat target/x86_64-pc-windows-gnu/release/rc64.exe

Usage

Boot to C64 prompt

target/release/rc64

Start & autoload a PRG file

target/release/rc64 path/to/game.prg

Run test suite

cargo test --release

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Above licensing does not apply to the vendored 6502 functional test suite in the sub-directory dormann_6502_functional_test_suite, which is licensed under GPLv3 (see dormann_6502_functional_test_suite/vendor_upstream_6502_functional_test_suite_fe99e5616243a1bdbceaf5907390ce4443de7db0.tar)

Performance Measurement

# make sure Cargo.toml has profile.release.debug = true
cargo build --release

NUM_CYCLES=50000000

# host instructions / guest cycles
perf stat  target/release/rc64 \
    --exit-after-cycles $NUM_CYCLES --disable-clock-freq-limit \
    PATH_TO_PRG
# => compute yourself

# flame graph
perf record -D 5000 --call-graph=dwarf  target/release/rc64 \
    --exit-after-cycles $NUM_CYCLES --disable-clock-freq-limit \
    PATH_TO_PRG
cargo install inferno
perf script| inferno-collapse-perf | inferno-flamegraph > flamegraph.svg