https://github.com/dcdeepesh/abm

A Boring Machine
https://github.com/dcdeepesh/abm

assembly interpreter virtual-machine

Last synced: 24 days ago
JSON representation

A Boring Machine

• Host: GitHub
• URL: https://github.com/dcdeepesh/abm
• Owner: dcdeepesh
• License: gpl-3.0
• Created: 2023-09-27T04:34:05.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-08-16T10:26:22.000Z (6 months ago)
• Last Synced: 2024-08-16T12:56:07.504Z (6 months ago)
• Topics: assembly, interpreter, virtual-machine
• Language: C
• Homepage:
• Size: 90.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ABM - A Boring Machine

ABM is a stack-based virtual machine with an interpreted assembly-like source code syntax.

This was just a personal project to learn and experiment, and is not suited for any real-world

use. As a result, ABM is not Turing complete. You are welcome to try it out though.

[Example ABM code](samples/complete/factorial.abm) (calculates and prints the factorial of 7):

```

lvalue i

push 7

:=

lvalue result

push 1

:=

label loop

    rvalue i

    push 0

    =

    gotrue end

    lvalue result

    rvalue result

    rvalue i

    *

    :=

    lvalue i

    rvalue i

    push 1

    -

    :=

goto loop

label end

rvalue result

print

```

Output:

```

5040

```

## Building

ABM doesn't have any dependencies and has a very simple build process, therefore no build tools are used.

To build from source, clone this repository, `cd` into `src`, and run:

```sh

# *nix (bash):

gcc -I. -o abm *.c **/*.c

# Windows (Powershell)

gcc -I. -o abm.exe @(Get-ChildItem -Recurse -Filter *.c).FullName

```

This will create an executable named `abm` (or `abm.exe`) in the directory.

## Usage & Source Code

The ABM binary takes a single argument, an ABM source file. Providing no argument displays a short

usage. The file can be named anything and the extension doesn't matter, even though the provided

samples use the extension `.abm`.

The ABM source code resembles assembly code, but technically is higher level than assembly. Therefore,

it is more appropriate to call it an interpreted language that just resembles assembly code.

Each line in an ABM source file contains an instruction and the argument to that instruction (if any),

separated by the first space. The lines are trimmed when being parsed, allowing the code to be indented

as needed. Empty lines (and lines containing only whitespace) are skipped. Comments are not supported.

The full instruction set for ABM can be found [in the ISA](docs/isa.md).

## Samples

Some samples are included in the repository in `samples`. The `.abm` files contain the sources and the

corresponding `.output` files contain their outputs. The directory `complete` contains more "complete"

samples, like full programs, rather than small test programs like the rest of the samples.