summaryrefslogtreecommitdiff
path: root/vm/vm.go
blob: f6499fd0771c61a9a604e7d921f4fc61601d6062 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
package vm

import (
	"fmt"     // for tracing only
	"log"     // for tracing only
	"reflect" // for optional CallX only
	"strconv" // for tracing only
)

const debug = true

// Byte-code instruction set.
const (
	// instruction effect on stack: values consumed -- values produced
	Nop       = iota // --
	Add              // n1 n2 -- sum ; sum = n1+n2
	Assign           // val -- ; mem[$1] = val
	Fassign          // val -- ; mem[$1] = val
	Call             // f [a1 .. ai] -- [r1 .. rj] ; r1, ... = prog[f](a1, ...)
	Calli            // f [a1 .. ai] -- [r1 .. rj] ; r1, ... = prog[f](a1, ...)
	CallX            // f [a1 .. ai] -- [r1 .. rj] ; r1, ... = mem[f](a1, ...)
	Dup              // addr -- value ; value = mem[addr]
	Fdup             // addr -- value ; value = mem[addr]
	Equal            // n1 n2 -- cond ; cond = n1 == n2
	Exit             // -- ;
	Greater          // n1 n2 -- cond; cond = n1 > n2
	Jump             // -- ; ip += $1
	JumpTrue         // cond -- ; if cond { ip += $1 }
	JumpFalse        // cond -- ; if cond { ip += $1 }
	Lower            // n1 n2 -- cond ; cond = n1 < n2
	Loweri           // n1 -- cond ; cond = n1 < $1
	Mul              // n1 n2 -- prod ; prod = n1*n2
	Pop              // v --
	Push             // -- v
	Return           // [r1 .. ri] -- ; exit frame: sp = fp, fp = pop
	Sub              // n1 n2 -- diff ; diff = n1 - n2
	Subi             // n1 -- diff ; diff = n1 - $1
)

var strop = [...]string{ // for VM tracing.
	Nop:       "Nop",
	Add:       "Add",
	Assign:    "Assign",
	Call:      "Call",
	Calli:     "Calli",
	CallX:     "CallX",
	Dup:       "Dup",
	Equal:     "Equal",
	Exit:      "Exit",
	Fassign:   "Fassign",
	Fdup:      "Fdup",
	Greater:   "Greater",
	Jump:      "Jump",
	JumpTrue:  "JumpTrue",
	JumpFalse: "JumpFalse",
	Lower:     "Lower",
	Loweri:    "Loweri",
	Mul:       "Mul",
	Pop:       "Pop",
	Push:      "Push",
	Return:    "Return",
	Sub:       "Sub",
	Subi:      "Subi",
}

// Machine represents a virtual machine.
type Machine struct {
	code   [][]int64 // code to execute
	mem    []any     // memory, as a stack
	ip, fp int       // instruction and frame pointer
	ic     uint64    // instruction counter, incremented at each instruction executed
	// flags  uint      // to set options such as restrict CallX, etc...
}

// Run runs a program.
func (m *Machine) Run() (err error) {
	code, mem, ip, fp, sp, ic := m.code, m.mem, m.ip, m.fp, 0, m.ic

	defer func() { m.mem, m.ip, m.fp, m.ic = mem, ip, fp, ic }()

	trace := func() {
		if !debug {
			return
		}
		var op2, op3 string
		c := code[ip]
		if l := len(c); l > 2 {
			op2 = strconv.Itoa(int(c[2]))
			if l > 3 {
				op3 = strconv.Itoa(int(c[3]))
			}
		}
		log.Printf("ip:%-4d sp:%-4d fp:%-4d op:[%-9s %-4s %-4s] mem:%v\n", ip, sp, fp, strop[c[1]], op2, op3, mem)
	}

	for {
		sp = len(mem) // stack pointer
		trace()
		ic++
		switch op := code[ip]; op[1] {
		case Add:
			mem[sp-2] = mem[sp-2].(int) + mem[sp-1].(int)
			mem = mem[:sp-1]
		case Mul:
			mem[sp-2] = mem[sp-2].(int) * mem[sp-1].(int)
			mem = mem[:sp-1]
		case Assign:
			mem[op[2]] = mem[sp-1]
			mem = mem[:sp-1]
		case Fassign:
			mem[fp+int(op[2])-1] = mem[sp-1]
			mem = mem[:sp-1]
		case Call:
			nip := mem[sp-1].(int)
			mem = append(mem[:sp-1], ip+1, fp)
			ip = nip
			fp = sp + 1
			continue
		case Calli:
			mem = append(mem, ip+1, fp)
			fp = sp + 2
			ip += int(op[2])
			continue
		case CallX: // Should be made optional.
			l := int(op[2])
			in := make([]reflect.Value, l)
			for i := range in {
				in[i] = reflect.ValueOf(mem[sp-2-i])
			}
			f := reflect.ValueOf(mem[sp-1])
			mem = mem[:sp-l-1]
			for _, v := range f.Call(in) {
				mem = append(mem, v.Interface())
			}
		case Dup:
			mem = append(mem, mem[int(op[2])])
		case Equal:
			mem[sp-2] = mem[sp-2].(int) == mem[sp-1].(int)
			mem = mem[:sp-1]
		case Exit:
			return err
		case Fdup:
			mem = append(mem, mem[int(op[2])+fp-1])
		case Jump:
			ip += int(op[2])
			continue
		case JumpTrue:
			cond := mem[sp-1].(bool)
			mem = mem[:sp-1]
			if cond {
				ip += int(op[2])
				continue
			}
		case JumpFalse:
			cond := mem[sp-1].(bool)
			mem = mem[:sp-1]
			if !cond {
				ip += int(op[2])
				continue
			}
		case Greater:
			mem[sp-2] = mem[sp-1].(int) > mem[sp-2].(int)
			mem = mem[:sp-1]
		case Lower:
			mem[sp-2] = mem[sp-1].(int) < mem[sp-2].(int)
			mem = mem[:sp-1]
		case Loweri:
			mem[sp-1] = mem[sp-1].(int) < int(op[2])
		case Pop:
			mem = mem[:sp-int(op[2])]
		case Push:
			mem = append(mem, int(op[2]))
		case Return:
			ip = mem[fp-2].(int)
			ofp := fp
			fp = mem[fp-1].(int)
			mem = append(mem[:ofp-int(op[2])-int(op[3])-1], mem[sp-int(op[2]):]...)
			continue
		case Sub:
			mem[sp-2] = mem[sp-1].(int) - mem[sp-2].(int)
			mem = mem[:sp-1]
		case Subi:
			mem[sp-1] = mem[sp-1].(int) - int(op[2])
		}
		ip++
	}
}

func (m *Machine) PushCode(code ...[]int64) (p int) {
	p = len(m.code)
	m.code = append(m.code, code...)
	return p
}

func (m *Machine) SetIP(ip int)          { m.ip = ip }
func (m *Machine) Push(v ...any) (l int) { l = len(m.mem); m.mem = append(m.mem, v...); return l }
func (m *Machine) Pop() (v any)          { l := len(m.mem) - 1; v = m.mem[l]; m.mem = m.mem[:l]; return v }
func (m *Machine) Top() (v any) {
	if l := len(m.mem); l > 0 {
		v = m.mem[l-1]
	}
	return v
}

func (m *Machine) PopExit() {
	if l := len(m.code); l > 0 && m.code[l-1][1] == Exit {
		m.code = m.code[:l-1]
	}
}

func CodeString(op []int64) string {
	switch len(op) {
	case 2:
		return strop[op[1]]
	case 3:
		return fmt.Sprintf("%s %d", strop[op[1]], op[2])
	case 4:
		return fmt.Sprintf("%s %d %d", strop[op[1]], op[2], op[3])
	}
	return ""
}

// Disassemble returns the code as a readable string.
func Disassemble(code [][]int64) (asm string) {
	for _, op := range code {
		asm += CodeString(op) + "\n"
	}
	return asm
}