mirror of
https://github.com/kmc7468/cs420.git
synced 2025-12-16 07:28:52 +00:00
169 lines
5.3 KiB
Markdown
169 lines
5.3 KiB
Markdown
# KECC: KAIST Educational C Compiler
|
|
|
|
## Install
|
|
|
|
Install [rustup](https://rustup.rs/).
|
|
|
|
|
|
## Build
|
|
|
|
```sh
|
|
cargo build # debug build
|
|
cargo build --release # release build
|
|
```
|
|
|
|
|
|
## Run
|
|
|
|
```sh
|
|
cargo run --features=build-bin -- -h # print options
|
|
cargo run --features=build-bin -- -p examples/c/fibonacci.c # parse
|
|
cargo run --features=build-bin -- -i examples/c/fibonacci.c # irgen
|
|
cargo run --features=build-bin -- -O --iroutput examples/c/fibonacci.c # optimize
|
|
cargo run --features=build-bin -- examples/c/fibonacci.c # compile
|
|
|
|
cargo run --features=build-bin -- --irrun examples/c/fibonacci.c # interprets the IR
|
|
cargo run --features=build-bin -- --irviz fibonacci.png examples/c/fibonacci.c # visualizes the IR
|
|
|
|
cargo run --features=build-bin --release -- examples/c/fibonacci.c # compile with release build
|
|
```
|
|
|
|
For more information, please refer to the [KECC User's Manual](bin/README.md).
|
|
|
|
|
|
## Test
|
|
|
|
```sh
|
|
RUST_MIN_STACK=33554432 cargo test # debug build test
|
|
RUST_MIN_STACK=33554432 cargo test --release # release build test
|
|
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_write_c # run write_c test
|
|
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_irgen_small # run irgen test using a small subset of examples
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_irgen # run irgen test
|
|
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_simplify_cfg # run simplify_cfg test
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_mem2reg # run mem2reg test
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_deadcode # run deadcode test
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_gvn # run gvn test
|
|
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_asmgen_small # run asmgen test using a small subset of examples
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_asmgen # run asmgen test
|
|
|
|
RUST_MIN_STACK=33554432 cargo test test_examples_end_to_end # run irgen, optimize and asmgen pipeline test
|
|
```
|
|
|
|
`RUST_MIN_STACK=33554432` is necessary for deep call stack for irgen tests.
|
|
|
|
|
|
## Fuzzing
|
|
|
|
We encourage you to do homework using the test-driven development approach (TDD). You randomly
|
|
generate test input, and if it fails, then reduce it as much as possible and manually inspect the
|
|
reduced test input. For example:
|
|
|
|
```sh
|
|
# Randomly generates test inputs and tests them
|
|
python3 tests/fuzz.py <fuzz-option>
|
|
|
|
# Reduces the failing test input as much as possible
|
|
python3 tests/fuzz.py <fuzz-option> --reduce
|
|
|
|
# Fix your code for the reduced test input
|
|
cat tests/test_reduced.c
|
|
```
|
|
|
|
`<fuzz-option>` can be `--print` or `--irgen`. It shall be the one used in [Run](#run).
|
|
|
|
For more information on usage, please refer to the [Fuzzer User's Manual](tests/README.md).
|
|
|
|
### Install
|
|
|
|
```sh
|
|
# Ubuntu 20.04
|
|
sudo apt install -y build-essential clang make cmake python3 csmith libcsmith-dev creduce
|
|
pip3 install tqdm
|
|
```
|
|
|
|
### Run
|
|
|
|
The following script generates 10 random test cases and tests your C AST printer:
|
|
|
|
```sh
|
|
python3 tests/fuzz.py --help # print options
|
|
python3 tests/fuzz.py --print -n10 # test C AST printer for 10 times
|
|
```
|
|
|
|
We use `csmith` to randomly generate C source codes. `csmith` will be automatically downloaded and
|
|
built by the test script. For more information, we refer to the
|
|
[Csmith](https://embed.cs.utah.edu/csmith/) homepage.
|
|
|
|
### Reduce
|
|
|
|
When the fuzzer finds a buggy input program for your compiler, it is highly likely that the input
|
|
program is too big to manually inspect. We use `creduce` that reduces the buggy input program as
|
|
much as possible.
|
|
|
|
Suppose `tests/test_polished.c` is the buggy input program. Then the following script reduces the
|
|
program to `tests/test_reduced.c`:
|
|
|
|
```sh
|
|
python3 tests/fuzz.py <fuzz-option> --reduce
|
|
```
|
|
|
|
`<fuzz-option>` can be `--print` or `--irgen`. It shall be the one used in [Run](#run).
|
|
|
|
### How it reduces test case?
|
|
|
|
The script performs unguided test-case reduction using `creduce`: given a buggy program, it randomly
|
|
reduces the program; check if the reduced program still fails on the test, and if so, replaces the
|
|
given program with the reduced one; repeat until you get a small enough buggy program. For more
|
|
information, we refer to the [Creduce](https://embed.cs.utah.edu/creduce/) homepage.
|
|
|
|
**[NOTICE]** The fuzzer supports Ubuntu 20.04 only. It may work for other platforms, but if it
|
|
doesn't, please run the fuzzer in Ubuntu 20.04.
|
|
|
|
## Running RISC-V Binaries
|
|
|
|
### RISC-V Documentation
|
|
|
|
- ISA: <https://riscv.org/technical/specifications/>
|
|
- ELF calling convention: <https://github.com/riscv-non-isa/riscv-elf-psabi-doc>
|
|
|
|
### Install
|
|
|
|
```sh
|
|
# Ubuntu 20.04
|
|
sudo apt install gcc-riscv64-linux-gnu g++-riscv64-linux-gnu qemu-user-static
|
|
```
|
|
|
|
### Cross-Compilation and Architecture-Emulation
|
|
|
|
```sh
|
|
# Compile C source code into RISC-V assembly
|
|
riscv64-linux-gnu-gcc hello.c -S -fsigned-char -o hello.S
|
|
|
|
# Link to an RISC-V executable
|
|
riscv64-linux-gnu-gcc -static hello.S -o hello
|
|
|
|
# Emulate the executable
|
|
qemu-riscv64-static ./hello
|
|
|
|
# Check the return value
|
|
echo $?
|
|
```
|
|
|
|
|
|
## Run Benchmark for Performance Competition
|
|
|
|
```sh
|
|
cd bench
|
|
make run
|
|
```
|
|
|
|
|
|
## Submission
|
|
|
|
- Submit the corresponding files to [gg.kaist.ac.kr](https://gg.kaist.ac.kr).
|
|
- Run `./scripts/make-submissions.sh` to generate `hw2.zip` to `final.zip`, which you should submit for homework 2 to final project.
|