Status

• The full std library is supported.
• A custom version of KallistiOS is used. The custom version is updated regularly to track closely with the upstream master branch.
  • This version includes a libpthread addon layer to interface with the Rust standard library.
  • Wrappers are provided to invoke cargo and rustc in a familiar manner to compile projects.
• A kos-sys raw/unsafe bindings crate is provided for easily linking KallistiOS and its unsafe C API into Rust crates. This crate is in active development, but with the majority of KallistiOS functionality available now via C FFI.
• A kos-rs Rust crate with safe idiomatic interfaces is available but is in very early stages.
  • Documentation for the bindings is available at kos-rs.dreamcast.wiki.
  • If bindings do not yet exist for desired functionality, wrapping of KallistiOS C functions is required to get proper use of KallistiOS at this time. See the Foreign Function Interface page in the Rustonomicon for further understanding.
  • A custom libc crate with KallistiOS support is provided.
• Code generation uses rustc_codegen_gcc, so its limitations apply here. See the development blog for more information on its progress.
  • rustc_codegen_gcc is pinned to a particular Rust nightly version, but is synced regularly. The current version in use is the 2025-01-11 nightly.
  • A KallistiOS-patched version of the latest nightly is maintained and updated regularly.
  • Panic unwinding, debug info, LTO, etc. are not currently available.
  • Architectures dependent on rustc_codegen_gcc are not yet able to be added to the rustc frontend, so a workaround is necessary: MIPS is falsely selected for KallistiOS, causing rustc to emit objects with a MIPS header and a provided wrapper is used when linking to rewrite these MIPS headers to SuperH before passing the compiled objects to the linker.
• A separate development version of the GCC toolchain must be used.
  • This version of GCC contains the latest libgccjit patches necessary to interface with rustc_codegen_gcc, and will be built to work with the custom KallistiOS's libpthread layer.
  • New updates to rustc_codegen_gcc often require new updates to GCC, so recompiling GCC regularly will be necessary to keep up with the latest updates.
  • The development version of GCC does not always compile well on every platform. Using a modern Linux platform is recommended for maximum compatibility.
  • The custom KallistiOS and GCC environment can still be used to compile code or projects written in C, C++, etc.
• KallistiOS and all related libraries and tools must be compiled using the -m4-single ABI. This is already set up for you in the guide below, but if external libraries are being linked to Rust projects, make sure that code is compiled using the proper ABI.