This repository contains the source code for a simple assembler / compiler for our educational processor.
At the moment this repository consists of two projects. py-assembler is an assembler, written in Python and Super32 is an attempt to implement an actuall backend compiler with LLVM.
Full documentation is found on readthedocs.
These instructions will help you to get your environment ready to build, develop and run the project on your local machine.
You'll need the following tools for pyassembler:
- Python 3
- Python modules defined in requirements.txt
For the Super32 project you need:
Take a look at the instructionset of the Super32 processor. Also, feel free to include these fancy assembler directives to improve your code.
Here are some rules you always have to keep in mind when you write some assembler code:
Your code always has to start with
ORG address
START
and end with an
END
assembler directives, where address MUST be greater than and be able to devide by 4. Define constants in your memory like this
DEFINE 0
For easier referencing the constants in your code, put a lable in front of your constant
const: DEFINE 0
This python package is currently not available on official PyPi server. To install the package you first have to clone the git repository
git clone https://github.com/xsjad0/Super32.gitAfter you successfully cloned the repository, switch to the latest release and run the installation process via pip
git checkout X.Y.Z
pip install .If you do not have pip installed, use the following commands
python setup.py build
python setup.py installNavigate via cd in the super32assembler folder and provide an assembler code file via commandline argument.
cd super32assembler
python main.py example_code.s32If you want to define a custom output name / path, use the '-o' argument flag. All available options are listed in the table below.
| Option | Default | Description |
|---|---|---|
| -h/--help | - | Display help information |
| -o/--output | <input-file>.o | Custom output name / path |
| -g/--generator | lines | Specify output format. use lines to generate 32bit machine-code each line. Use stream to generate one single line machine-code. |
| -a/--architecture | single | Specify processor architecture. use single to select single-memory architecture. Use multi to select dual-memory architecture. |
We use pytest for testing. To run these test use:
pytest test_{test_name}.pyWe use SemVer for versioning. For the versions available, see the releases on this repository.
This project is licensed under the MIT License - see the LICENSE file for details