Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/berzanorg/bytecode-compiler
A bytecode compiler written in Rust.
https://github.com/berzanorg/bytecode-compiler
bytecode compiler lexer parser virtual-machine
Last synced: about 2 months ago
JSON representation
A bytecode compiler written in Rust.
- Host: GitHub
- URL: https://github.com/berzanorg/bytecode-compiler
- Owner: BerzanOrg
- License: mit
- Created: 2023-10-19T12:03:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-19T20:19:23.000Z (over 1 year ago)
- Last Synced: 2024-01-25T22:54:13.650Z (about 1 year ago)
- Topics: bytecode, compiler, lexer, parser, virtual-machine
- Language: Rust
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bytecode-compiler
This project is built to explore how lexers, parsers, compilers and virtual machines work.
This project doesn't have any dependency and is built from scratch.
This project has unit tests for many of its modules.
# Virtual Machine Overview
Virtual machine implementation is like below.
```rust
pub struct VirtualMachine {
stack: Vec,
register: [Value; REGISTER_SIZE],
bytecode: Vec,
program_counter: usize,
}
```
# Language Overview
A sample program is below.
```js
PUSH 10
PUSH 40
ADD
RET
```
# Opcodes
Opcode: **PUSH**
Pushes a value to the stack of the virtual machine.
```js
PUSH // type of value is `i64`
```
Opcode: **POP**
Removes the last value from the stack.
```js
POP
```
Opcode: **STORE**
Stores the last value from the stack at specified index in the register of the virtual machine.
```js
STORE // type of index is `u8`
```
Opcode: **LOAD**
Pushes the value at the specified index in the register to the stack.
```js
LOAD // type of index is `u8`
```
Opcode: **ADD**
Removes the last 2 values from the stack. And pushes the sum of them back.
```js
ADD
```
Opcode: **SUB**
Removes the last 2 values from the stack. And pushes the subtraction of them back.
```js
SUB
```
Opcode: **MUL**
Removes the last 2 values from the stack. And pushes the multiplication of them back.
```js
MUL
```
Opcode: **DIV**
Removes the last 2 values from the stack. And pushes the division of them back.
```js
DIV
```
Opcode: **MOD**
Removes the last 2 values from the stack. And pushes the modulo of them back.
```js
MOD
```
Opcode: **RET**
Stops the execution of the program. And returns the values in the stack.
```js
RET
```
# Development
### Setup A Development Environment
You need [Rust Language](https://www.rust-lang.org/) installed.
Or you can use [Dev Containers](https://containers.dev/) to easily setup a development environment.
### Clone The Repo
Run the command below to clone the repository.
```sh
git clone https://github.com/BerzanXYZ/bytecode-compiler.git
```
### Set Your Working Directory
Run the command below to set your working directory to `bytecode-compiler/`.
```sh
cd bytecode-compiler/
```
### Build The Program
Run the command below to build the program.
```sh
cargo build --release
```
### Run The Examples
Run the command below to run the examples.
```sh
./target/release/bytecode-compiler examples/adding.code # or examples/complex.code
```