Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

# Keep package mirror/network stalls bounded, separately from analysis time.
# apt options below retain retries and fail with the actual download error.
jobs:
# Runners are disposable, so these build the dev profile on purpose. The
# release-only rule in CLAUDE.md is about the maintainer's machine.
Expand All @@ -45,6 +47,10 @@ jobs:
test:
runs-on: ubuntu-latest
timeout-minutes: 45
env:
# Whole-corpus decompilation takes tens of minutes without optimization.
# Keep test-profile debug assertions and overflow checks enabled.
CARGO_PROFILE_TEST_OPT_LEVEL: 2
steps:
- uses: actions/checkout@v4
# The AArch64 std, for the Rust fixture: `build-fixtures.sh` builds it
Expand All @@ -68,8 +74,8 @@ jobs:
# golang-go the Go fixture, which found five decoder bugs
- name: Install the oracles
run: |
sudo apt-get update
sudo apt-get install -y clang llvm binutils qemu-user-static golang-go \
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 update
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 install -y clang llvm binutils qemu-user-static golang-go \
gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
- name: Build the fixture corpus
run: ./scripts/build-fixtures.sh
Expand Down Expand Up @@ -98,8 +104,8 @@ jobs:
# The cross gcc because this runner is x86-64 and a `.a64` fixture
# has to be AArch64; qemu because several of them are executed.
- run: |
sudo apt-get update
sudo apt-get install -y clang \
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 update
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 install -y clang \
gcc-aarch64-linux-gnu g++-aarch64-linux-gnu qemu-user-static
- run: ./scripts/build-fixtures.sh
- run: cargo build --release
Expand Down Expand Up @@ -131,8 +137,8 @@ jobs:
# The cross gcc because this runner is x86-64 and a `.a64` fixture
# has to be AArch64; qemu because several of them are executed.
- run: |
sudo apt-get update
sudo apt-get install -y clang binutils \
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 update
sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 install -y clang binutils \
gcc-aarch64-linux-gnu g++-aarch64-linux-gnu qemu-user-static
- run: ./scripts/build-fixtures.sh
# Release, like determinism above: the recall numbers have to come from
Expand All @@ -154,7 +160,7 @@ jobs:
steps:
- uses: actions/checkout@v4
- run: sh -n install.sh
- run: sudo apt-get update -q && sudo apt-get install -y shellcheck
- run: sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 update -q && sudo apt-get -o Acquire::Retries=2 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30 install -y shellcheck
- run: shellcheck --shell=sh install.sh
# The one thing syntax cannot see: that the script still knows where the
# release puts things. `build-release.sh` names the archive and the
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,9 @@ jobs:
$name = "e5r-$version-x86_64-pc-windows-msvc"
New-Item -ItemType Directory -Force -Path "dist/$name" | Out-Null
Copy-Item "target/x86_64-pc-windows-msvc/release/e5r.exe" "dist/$name/"
Copy-Item README.md, LICENSE, MANUAL.md "dist/$name/"
Copy-Item README.md, LICENSE "dist/$name/"
New-Item -ItemType Directory -Force -Path "dist/$name/docs" | Out-Null
Copy-Item docs/MANUAL.md, docs/ROADMAP.md, docs/dashboard.md "dist/$name/docs/"
& "dist/$name/e5r.exe" --version
Compress-Archive -Path "dist/$name" -DestinationPath "dist/$name.zip"
- uses: actions/upload-artifact@v4
Expand Down
231 changes: 231 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Custom
workspace/

# Rust
/target/
**/*.rs.bk
Expand Down Expand Up @@ -29,3 +32,231 @@

# Release archives, built by scripts/build-release.sh.
dist/

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[codz]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py.cover
*.lcov
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
# Pipfile.lock

# uv
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# uv.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
# poetry.lock
# poetry.toml

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
# pdm.lock
# pdm.toml
.pdm-python
.pdm-build/

# pixi
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
# pixi.lock
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
# in the .venv directory. It is recommended not to include this directory in version control.
.pixi/*
!.pixi/config.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule*
celerybeat.pid

# Redis
*.rdb
*.aof
*.pid

# RabbitMQ
mnesia/
rabbitmq/
rabbitmq-data/

# ActiveMQ
activemq-data/

# SageMath parsed files
*.sage.py

# Environments
.env
.envrc
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs/Zensical documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
# .idea/

# Abstra
# Abstra is an AI-powered process automation framework.
# Ignore directories containing user credentials, local state, and settings.
# Learn more at https://abstra.io/docs
.abstra/

# Visual Studio Code
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
# and can be added to the global gitignore or merged into this file. However, if you prefer, you
# could uncomment the following to ignore the entire vscode folder
# .vscode/
# Temporary file for partial code execution
tempCodeRunnerFile.py

# Ruff stuff:
.ruff_cache/

# PyPI configuration file
.pypirc

# Marimo
marimo/_static/
marimo/_lsp/
__marimo__/

# Streamlit
.streamlit/secrets.toml

# Local task-store write locks and atomic-write scratch files. Task JSON is durable.
*.work/.lock
*.work/*.tmp

*.work/*/.lock
*.work/*/*.tmp
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CLAUDE.md

Scope, milestones and the list of things this project will not build live in
[`ROADMAP.md`](ROADMAP.md). Read that first.
[`ROADMAP.md`](docs/ROADMAP.md). Read that first.

## This checkout is release-only

Expand Down
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# CLAUDE.md

Scope, milestones and the list of things this project will not build live in
[`ROADMAP.md`](ROADMAP.md). Read that first.
[`ROADMAP.md`](docs/ROADMAP.md). Read that first.

## This checkout is release-only

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ and under what licence, in the file that uses it.
## What a change has to come with

Every claim this tool makes is measured, and a change that makes a claim has to
bring its measurement. `ROADMAP.md` says what each milestone is gated on; the
bring its measurement. `docs/ROADMAP.md` says what each milestone is gated on; the
short version:

- **An external oracle wherever one exists.** A decoder is compared against
Expand Down
Loading
Loading