~A register based bytecode virtual machine implementation by smv.

Lightweight and fast, written under 1400 lines of code.

Currently the docs are in making (or being "transported" from past projects) so for now there's only BYTECODE and INSTRUCTIONSET. Updates are major TODO.

This VM is primarily meant to be embedded into C. Practically nobody should be using it barebones without something like a JIT compiler built on top of it. But there's nothing stopping you from doing that. (evil laughter?)

This is mostly a personal project, something that can be embedded into larger systems.

• smvm - the smv virtual machine
  • Contents:
  • Usage
    • Basic Usage
    • C Interoperability
  • Build and Install

Know more:

1. Instruction set
2. Bytecode
3. List of examples: examples/

The VM is meant to be embedded into C but it can be used as a standalone, to run assembly as well as smvm bytecode.

To use SMVM as a standalone VM:

1. Build the VM:

make dev

2. Run an assembly file:

make run_asmv FILE=examples/test.asmv
# or directly:
./out/smvm examples/test.asmv

3. Run tests:

make test

To embed SMVM in your C program:

1. Install the library:

make install

2. Include the headers in your C file:

#include <smvm/smvm.h>

3. Basic usage example:

#include <smvm/smvm.h>

int main() {
  smvm vm;

  smvm_init(&vm);

  char *code =
      "puts \"hello, word! here's my lucky number: \""
      "mov ra 42\n"
      "puti ra\n"
      "halt";

  smvm_assemble(&vm, code);
  smvm_execute(&vm);
  smvm_free(&vm);

  return 0;
}

4. Compile your program with:

cc your_program.c -lsmvm

1. Build the development version:

make dev

2. Install the library system-wide:

make install

3. Build libraries only:

make out/libsmvm.a    # Static library
make out/libsmvm.so   # Shared library

For more build options:

make help