corten/docs/spec.md

# Specifications

## Iridium

Corten is based on Fletcher Haynes's [So you want to build a language VM](https://blog.subnetzero.io/post/building-language-vm-part-01/) tutorial. His virtual machine used for the tutorial is known as [Iridium](https://github.com/fhaynes/iridium) and is based on the [MIPS64 Release 6](https://en.wikipedia.org/wiki/MIPS_architecture#MIPS32/MIPS64_Release_6) architecture. Corten aims to be Iridium 1-compatible.

## Instruction Set 

| Opcode | Function | Comment |
| --- | --- | --- |
| 0 | LOAD | Load program |
| 1 | ADD |
| 2 | SUB |
| 3 | MUL |
| 4 | DIV |
| 5 | HLT | Halt |
| 6 | JMP | Jump |
| 7 | JMPF | Jump forward |
| 8 | JMPB | Jump backward |
| 9 | EQ | Equal |
| 10 | NEQ | Not equal |
| 11 | GTE | Greater then or equal to |
| 12 | GT | Greater then |
| 13 | LTE | Less then or equal to |
| 14 | LT | Less then |
| 15 | JMPE | Jump if equal |
| 16 | NOP |
| _ | IGL | Illegal action |
Rearranaged opcode order - Rearranaged opcodes to match Iridium's - Grabbed the get_test_vm() function from the Iridium 1 source to keep up with the tutorial - Specifications page with details regarding Iridium and Corten's instruction set list 2020-02-06 19:57:38 -05:00			`# Specifications`

			`## Iridium`

Updated spec page 2020-02-07 02:17:59 -05:00			`Corten is based on Fletcher Haynes's [So you want to build a language VM](https://blog.subnetzero.io/post/building-language-vm-part-01/) tutorial. His virtual machine used for the tutorial is known as [Iridium](https://github.com/fhaynes/iridium) and is based on the [MIPS64 Release 6](https://en.wikipedia.org/wiki/MIPS_architecture#MIPS32/MIPS64_Release_6) architecture. Corten aims to be Iridium 1-compatible.`
Rearranaged opcode order - Rearranaged opcodes to match Iridium's - Grabbed the get_test_vm() function from the Iridium 1 source to keep up with the tutorial - Specifications page with details regarding Iridium and Corten's instruction set list 2020-02-06 19:57:38 -05:00
			`## Instruction Set`

Initial start on equality checks 2020-02-06 21:40:09 -05:00			`\| Opcode \| Function \| Comment \|`
			`\| --- \| --- \| --- \|`
			`\| 0 \| LOAD \| Load program \|`
Rearranaged opcode order - Rearranaged opcodes to match Iridium's - Grabbed the get_test_vm() function from the Iridium 1 source to keep up with the tutorial - Specifications page with details regarding Iridium and Corten's instruction set list 2020-02-06 19:57:38 -05:00			`\| 1 \| ADD \|`
			`\| 2 \| SUB \|`
			`\| 3 \| MUL \|`
			`\| 4 \| DIV \|`
Fixed mis-numbering of opcodes This bug was intentionally kept in order to make sure everything ran flawlessly regardless. 2020-02-07 01:01:39 -05:00			`\| 5 \| HLT \| Halt \|`
			`\| 6 \| JMP \| Jump \|`
			`\| 7 \| JMPF \| Jump forward \|`
			`\| 8 \| JMPB \| Jump backward \|`
			`\| 9 \| EQ \| Equal \|`
			`\| 10 \| NEQ \| Not equal \|`
			`\| 11 \| GTE \| Greater then or equal to \|`
			`\| 12 \| GT \| Greater then \|`
Updated spec page 2020-02-07 02:17:59 -05:00			`\| 13 \| LTE \| Less then or equal to \|`
			`\| 14 \| LT \| Less then \|`
Fixed mis-numbering of opcodes This bug was intentionally kept in order to make sure everything ran flawlessly regardless. 2020-02-07 01:01:39 -05:00			`\| 15 \| JMPE \| Jump if equal \|`
			`\| 16 \| NOP \|`
Initial start on equality checks 2020-02-06 21:40:09 -05:00			`\| _ \| IGL \| Illegal action \|`