THIS PROJECT HAS BEEN MOVED TO https://www.github.com/MegrajChauhan/MerryV2

The reason for this is the misbehaviour of CMAKE.

MERRY

Merry is a 64-bit Virtual Machine that emulates a non-existsent CPU. Merry has it's own custom ISA that is still small but is growing steadily. Merry aspires to be a very easy-to-use and simple tool for problem solving. It has 180 different instructions that can be employed to solve all sorts of problems and that is still only a fraction of what it can do in the future.

Note: If you wish to learn about the instructions that Merry supports or how they are encoded, please look in docs/opcodes.txt where I have tried my best to explain it.

Features:

1. Custom ISA.
2. Very fast execution.
3. Custom input format.
4. IO capabilities.
5. Multi-threading(Untested)
6. Arithmetic instructions(signed and unsigned).
7. Floating point instructions(Untested).
8. Assembler(Basic one done).
9. Programming Language(In development).
10. Dynamic Library Loading(tested for linux only).
11. File IO(Not fully tested) and comming soon....

Building the VM:

Due to my lack of knowledge in build systems, I have had to use a script written in Python for building. For building the project, here is the command to run:

python build.py <Destination Folder>

Note that the above command must be ran in the same directory as the script. If the destination directory doesn't exist already, create one first. "gcc" is the compiler needed for the compilation of the VM while "g++" is needed for the assembler.

Running Programs:

In order to make merry run any program, first go into the directory where the compiled executable resides and type the following command:

./merry -f <input file path>

This will make merry read the input file and start executing it.

Things to know:

Merry is still in development and hence it is appreciated for feedback on test failures. Many features are yet to be implemented.

Run Tests:

Goto example/run to look at example programs involving the assembly language. The syntax is inspired by x86_64 Nasm assembly which should be well knowm.

Note:

Previously when we had a simpler input file format, we used the Zeta assembler as our assembler to assemble the programs but now it will not suffice. We have a more complicated input file format now. This format requires new, more complex and complicated assembler which is not possible yet as I still have much new to add. So if you would like to implement an assembler on your own, please contact me via our patreon. I will then provide a complete description of Merry's ISA and input file format.

NOTE: test.t and output.bin are one of the tests of the newer file format. You can compile the VM and then run output.bin to see what happens. NOTE: The new format is still fully untested. Manual testing with handwritten binary programs will be bothersome but I have no choice and testing will take time.

What to expect?

Given the current development efforts, we can expect debugger support, networking support, maybe a dynamic library loader for Merry binaries, core dumps, and many more.