mirror of https://github.com/pound-emu/ballistic.git synced 2026-01-31 01:15:21 +01:00

Files

Ronald Caesar 3cf17ac088 tools: fix CDoc ordering of types

Fixes CDoc ordering the sidebar and main page types in alphabetical
order. Only the sidebar should be sorted and the main page should
be rendered the way its header file was parsed, top to bottom.

Signed-off-by: Ronald Caesar <github43132@proton.me>

2026-01-17 02:06:36 -04:00

ballistic_cli.c

tools: add ballistic cli program

2026-01-14 23:28:28 -04:00

cdoc.c

tools: fix CDoc ordering of types

2026-01-17 02:06:36 -04:00

coverage_cli.c

tools: add coverage cli program

2026-01-11 01:51:53 -04:00

decoder_cli.c

decoder: Make decoder API public

2025-12-12 18:11:43 -04:00

generate_a64_table.py

decoder: add ir opcode to metadata struct

2026-01-13 23:31:06 -04:00

README.md

tools: create a rustdoc like documentation generator

2026-01-16 20:23:12 -04:00

README.md

Tools

This folder holds scritps needed to build Ballistic and standalone programs used for testing Ballistic.

Standlone Programs

These programs will appear in directory you compile Ballistic with.

Ballistic CLI

This is used by developers to test Ballistic's translation loop.

CDoc

This creates rustdoc like documentation for C code. CDoc completely relies on Clang and LLVM so only Unix systems are supported. Builing CDoc on Windows is not supported at this time.

# Parses all header files in `include/` and output HTML files to `docs/cdoc`.
./cdoc docs/cdoc include/*
Using Clang headers: /usr/lib/clang/21/include
Parsing ../include/bal_attributes.h...
Parsing ../include/bal_decoder.h...
Parsing ../include/bal_engine.h...
Parsing ../include/bal_errors.h...
Parsing ../include/bal_memory.h...
Parsing ../include/bal_platform.h...
Parsing ../include/bal_types.h...
Generating HTML in '../docs/cdoc'...
Done! Open ../docs/cdoc/index.html

Disclaimer: I have absolutely zero motivation to create a documentation generator so cdoc.c is made completely with AI. The code is messy but the generated HTML files look beautiful.

Coverage CLI

This program takes an ARM64 binary file and outputs the 20 most common instructions.

Decoder CLI

This program is used for decoding ARM64 instructions. The following example shows how to use it:

./decoder_cli 0b5f1da1 # ADD extended registers
Mnemonic: ADD - Mask: 0x7F200000 - Expected: 0x0B000000

Scripts

These scripts are solely used for building Ballistic and is called by CMake.

Generate A64 Table

This script parses the Official ARM Machine Readable Architecture Specification XML files in spec/ and generates a hash table Ballistic's decoder uses to lookup instructions.