vm.c 20.2 KB
Newer Older
Damien's avatar
Damien committed
1
2
3
4
5
6
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>

7
#include "nlr.h"
Damien's avatar
Damien committed
8
#include "misc.h"
9
10
#include "mpconfig.h"
#include "obj.h"
Damien's avatar
Damien committed
11
#include "runtime.h"
12
#include "bc0.h"
13
#include "bc.h"
Damien's avatar
Damien committed
14

15
16
17
// (value) stack grows down (to be compatible with native code when passing pointers to the stack), top element is pointed to
// exception stack grows up, top element is pointed to

Damien's avatar
Damien committed
18
#define DECODE_UINT do { unum = *ip++; if (unum > 127) { unum = ((unum & 0x3f) << 8) | (*ip++); } } while (0)
Damien's avatar
Damien committed
19
20
#define DECODE_ULABEL do { unum = (ip[0] | (ip[1] << 8)); ip += 2; } while (0)
#define DECODE_SLABEL do { unum = (ip[0] | (ip[1] << 8)) - 0x8000; ip += 2; } while (0)
Damien's avatar
Damien committed
21
#define DECODE_QSTR do { qstr = *ip++; if (qstr > 127) { qstr = ((qstr & 0x3f) << 8) | (*ip++); } } while (0)
22
23
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
24
25
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
26

27
mp_obj_t mp_execute_byte_code(const byte *code, const mp_obj_t *args, uint n_args, uint n_state) {
28
29
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
30
    mp_obj_t *state = &temp_state[0];
31
    if (n_state > 10) {
32
        state = m_new(mp_obj_t, n_state);
33
    }
34
35
    mp_obj_t *sp = &state[0] - 1;

36
37
38
    // init args
    for (int i = 0; i < n_args; i++) {
        assert(i < 8);
39
        state[n_state - 1 - i] = args[i];
40
41
    }
    const byte *ip = code;
Damien George's avatar
Damien George committed
42
43
44
45
46
47

    // execute prelude to make any cells (closed over variables)
    {
        for (uint n_local = *ip++; n_local > 0; n_local--) {
            uint local_num = *ip++;
            if (local_num < n_args) {
48
                state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
49
            } else {
50
                state[n_state - 1 - local_num] = mp_obj_new_cell(MP_OBJ_NULL);
Damien George's avatar
Damien George committed
51
52
53
54
55
            }
        }
    }

    // execute the byte code
56
    if (mp_execute_byte_code_2(&ip, &state[n_state - 1], &sp)) {
57
58
59
        // it shouldn't yield
        assert(0);
    }
Damien George's avatar
Damien George committed
60

61
62
    // TODO check fails if, eg, return from within for loop
    //assert(sp == &state[17]);
63
64
65
    return *sp;
}

66
67
// fastn has items in reverse order (fastn[0] is local[0], fastn[-1] is local[1], etc)
// sp points to bottom of stack which grows up
68
bool mp_execute_byte_code_2(const byte **ip_in_out, mp_obj_t *fastn, mp_obj_t **sp_in_out) {
Damien's avatar
Damien committed
69
70
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

71
    const byte *ip = *ip_in_out;
72
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
73
74
    machine_uint_t unum;
    qstr qstr;
75
    mp_obj_t obj1, obj2;
76
    mp_obj_t fast0 = fastn[0], fast1 = fastn[-1], fast2 = fastn[-2];
77
    nlr_buf_t nlr;
Damien's avatar
Damien committed
78

79
80
    volatile machine_uint_t currently_in_except_block = 0; // 0 or 1, to detect nested exceptions
    machine_uint_t exc_stack[8]; // on the exception stack we store (ip, sp | X) for each block, X = previous value of currently_in_except_block
81
    machine_uint_t *volatile exc_sp = &exc_stack[0] - 1; // stack grows up, exc_sp points to top of stack
Damien's avatar
Damien committed
82

83
    // outer exception handling loop
Damien's avatar
Damien committed
84
    for (;;) {
85
86
87
88
89
        if (nlr_push(&nlr) == 0) {
            // loop to execute byte code
            for (;;) {
                int op = *ip++;
                switch (op) {
90
91
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
92
93
                        break;

94
95
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
96
97
                        break;

98
99
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
100
                        break;
Damien George's avatar
Damien George committed
101
102
103
104

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
105

106
                    case MP_BC_LOAD_CONST_SMALL_INT:
Damien's avatar
Damien committed
107
                        unum = (ip[0] | (ip[1] << 8) | (ip[2] << 16)) - 0x800000;
108
                        ip += 3;
109
                        PUSH(MP_OBJ_NEW_SMALL_INT(unum));
110
111
                        break;

112
113
114
115
116
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qstr)));
                        break;

117
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
118
119
120
121
                        DECODE_QSTR;
                        PUSH(rt_load_const_dec(qstr));
                        break;

122
                    case MP_BC_LOAD_CONST_ID:
123
124
125
126
                        DECODE_QSTR;
                        PUSH(rt_load_const_str(qstr)); // TODO
                        break;

127
128
129
130
131
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
                        PUSH(rt_load_const_str(qstr)); // TODO
                        break;

132
                    case MP_BC_LOAD_CONST_STRING:
133
134
135
136
                        DECODE_QSTR;
                        PUSH(rt_load_const_str(qstr));
                        break;

137
                    case MP_BC_LOAD_FAST_0:
138
139
140
                        PUSH(fast0);
                        break;

141
                    case MP_BC_LOAD_FAST_1:
142
143
144
                        PUSH(fast1);
                        break;

145
                    case MP_BC_LOAD_FAST_2:
146
147
148
                        PUSH(fast2);
                        break;

149
                    case MP_BC_LOAD_FAST_N:
150
                        DECODE_UINT;
151
                        PUSH(fastn[-unum]);
152
153
                        break;

154
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
155
                        DECODE_UINT;
156
157
158
159
160
161
162
163
164
165
                        if (unum == 0) {
                            obj1 = fast0;
                        } else if (unum == 1) {
                            obj1 = fast1;
                        } else if (unum == 2) {
                            obj1 = fast2;
                        } else {
                            obj1 = fastn[-unum];
                        }
                        PUSH(rt_get_cell(obj1));
Damien's avatar
Damien committed
166
167
                        break;

168
                    case MP_BC_LOAD_NAME:
169
170
171
172
                        DECODE_QSTR;
                        PUSH(rt_load_name(qstr));
                        break;

173
                    case MP_BC_LOAD_GLOBAL:
174
175
176
177
                        DECODE_QSTR;
                        PUSH(rt_load_global(qstr));
                        break;

178
                    case MP_BC_LOAD_ATTR:
179
                        DECODE_QSTR;
180
                        SET_TOP(rt_load_attr(TOP(), qstr));
181
182
                        break;

183
                    case MP_BC_LOAD_METHOD:
184
                        DECODE_QSTR;
185
186
                        rt_load_method(*sp, qstr, sp);
                        sp += 1;
187
188
                        break;

189
                    case MP_BC_LOAD_BUILD_CLASS:
190
191
192
                        PUSH(rt_load_build_class());
                        break;

193
                    case MP_BC_STORE_FAST_0:
194
195
196
                        fast0 = POP();
                        break;

197
                    case MP_BC_STORE_FAST_1:
198
199
200
                        fast1 = POP();
                        break;

201
                    case MP_BC_STORE_FAST_2:
202
203
204
                        fast2 = POP();
                        break;

205
                    case MP_BC_STORE_FAST_N:
206
                        DECODE_UINT;
207
                        fastn[-unum] = POP();
208
209
                        break;

210
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
211
                        DECODE_UINT;
212
213
214
215
216
217
218
219
220
221
                        if (unum == 0) {
                            obj1 = fast0;
                        } else if (unum == 1) {
                            obj1 = fast1;
                        } else if (unum == 2) {
                            obj1 = fast2;
                        } else {
                            obj1 = fastn[-unum];
                        }
                        rt_set_cell(obj1, POP());
Damien's avatar
Damien committed
222
223
                        break;

224
                    case MP_BC_STORE_NAME:
225
226
227
228
                        DECODE_QSTR;
                        rt_store_name(qstr, POP());
                        break;

229
                    case MP_BC_STORE_GLOBAL:
230
231
232
233
                        DECODE_QSTR;
                        rt_store_global(qstr, POP());
                        break;

234
                    case MP_BC_STORE_ATTR:
235
                        DECODE_QSTR;
236
237
                        rt_store_attr(sp[0], qstr, sp[-1]);
                        sp -= 2;
238
239
                        break;

240
                    case MP_BC_STORE_SUBSCR:
241
242
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
243
244
                        break;

245
                    case MP_BC_DUP_TOP:
246
                        obj1 = TOP();
247
248
249
                        PUSH(obj1);
                        break;

250
                    case MP_BC_DUP_TOP_TWO:
251
252
253
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
254
255
                        break;

256
                    case MP_BC_POP_TOP:
257
                        sp -= 1;
258
259
                        break;

260
                    case MP_BC_ROT_TWO:
261
                        obj1 = sp[0];
262
263
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
264
265
                        break;

266
                    case MP_BC_ROT_THREE:
267
                        obj1 = sp[0];
268
269
270
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
271
272
                        break;

273
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
274
275
                        DECODE_SLABEL;
                        ip += unum;
276
277
                        break;

278
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
279
                        DECODE_SLABEL;
280
                        if (rt_is_true(POP())) {
Damien's avatar
Damien committed
281
                            ip += unum;
282
283
284
                        }
                        break;

285
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
286
                        DECODE_SLABEL;
287
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
288
                            ip += unum;
289
290
291
                        }
                        break;

292
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
293
                        DECODE_SLABEL;
294
                        if (rt_is_true(TOP())) {
Damien's avatar
Damien committed
295
296
                            ip += unum;
                        } else {
297
                            sp--;
Damien's avatar
Damien committed
298
299
300
                        }
                        break;

301
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
302
                        DECODE_SLABEL;
303
                        if (rt_is_true(TOP())) {
304
                            sp--;
Damien's avatar
Damien committed
305
306
307
308
309
                        } else {
                            ip += unum;
                        }
                        break;

310
                        /* we are trying to get away without using this opcode
311
                    case MP_BC_SETUP_LOOP:
312
                        DECODE_UINT;
313
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
314
315
316
                        break;
                        */

Damien's avatar
Damien committed
317
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
318
                    case MP_BC_SETUP_EXCEPT:
Damien's avatar
Damien committed
319
320
                        DECODE_ULABEL; // except labels are always forward
                        *++exc_sp = (machine_uint_t)ip + unum;
321
322
                        *++exc_sp = (((machine_uint_t)sp) | currently_in_except_block);
                        currently_in_except_block = 0; // in a try block now
323
324
                        break;

325
                    case MP_BC_END_FINALLY:
326
327
328
329
330
331
332
333
                        // not implemented
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is an integer, does something else
                        // if TOS is None, just pops it and continues
                        // else error
                        assert(0);
                        break;

334
                    case MP_BC_GET_ITER:
335
                        SET_TOP(rt_getiter(TOP()));
336
337
                        break;

338
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
339
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
340
                        obj1 = rt_iternext(TOP());
341
                        if (obj1 == mp_const_stop_iteration) {
342
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
343
                            ip += unum; // jump to after for-block
344
345
346
347
348
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
349
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
350
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
351
352
353
354
                        // we are exiting an exception handler, so pop the last one of the exception-stack
                        assert(exc_sp >= &exc_stack[0]);
                        currently_in_except_block = (exc_sp[0] & 1); // restore previous state
                        exc_sp -= 2; // pop back to previous exception handler
355
356
                        break;

Damien's avatar
Damien committed
357
                    // matched againts: SETUP_EXCEPT
358
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
359
                        // TODO need to work out how blocks work etc
360
                        // pops block, checks it's an exception block, and restores the stack, saving the 3 exception values to local threadstate
Damien's avatar
Damien committed
361
                        assert(exc_sp >= &exc_stack[0]);
362
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
363
                        //exc_sp--; // discard ip
364
365
                        currently_in_except_block = (exc_sp[0] & 1); // restore previous state
                        exc_sp -= 2; // pop back to previous exception handler
366
                        //sp -= 3; // pop 3 exception values
367
368
                        break;

369
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
370
                        unum = *ip++;
371
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
372
373
                        break;

374
                    case MP_BC_BINARY_OP:
375
376
                        unum = *ip++;
                        obj2 = POP();
377
378
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
379
380
                        break;

381
                    case MP_BC_BUILD_TUPLE:
382
                        DECODE_UINT;
383
384
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
385
386
                        break;

387
                    case MP_BC_BUILD_LIST:
388
                        DECODE_UINT;
389
390
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
391
392
                        break;

393
                    case MP_BC_LIST_APPEND:
394
395
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
396
397
                        rt_list_append(sp[-unum], sp[0]);
                        sp--;
398
399
                        break;

400
                    case MP_BC_BUILD_MAP:
401
402
403
404
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

405
                    case MP_BC_STORE_MAP:
406
407
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
408
409
                        break;

410
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
411
                        DECODE_UINT;
412
413
414
                        // I think it's guaranteed by the compiler that sp[-unum - 1] is a map
                        rt_store_map(sp[-unum - 1], sp[0], sp[-1]);
                        sp -= 2;
Damien's avatar
Damien committed
415
416
                        break;

417
                    case MP_BC_BUILD_SET:
418
                        DECODE_UINT;
419
420
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
421
422
                        break;

423
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
424
                        DECODE_UINT;
425
426
427
                        // I think it's guaranteed by the compiler that sp[-unum] is a set
                        rt_store_set(sp[-unum], sp[0]);
                        sp--;
Damien's avatar
Damien committed
428
429
                        break;

430
#if MICROPY_ENABLE_SLICE
431
432
433
434
435
436
437
438
439
440
441
                    case MP_BC_BUILD_SLICE:
                        DECODE_UINT;
                        if (unum == 2) {
                            obj2 = POP();
                            obj1 = TOP();
                            SET_TOP(mp_obj_new_slice(obj1, obj2, NULL));
                        } else {
                            printf("3-argument slice is not supported\n");
                            assert(0);
                        }
                        break;
442
#endif
443

444
                    case MP_BC_UNPACK_SEQUENCE:
445
                        DECODE_UINT;
446
447
                        rt_unpack_sequence(sp[0], unum, sp + unum - 1);
                        sp += unum - 1;
448
449
                        break;

450
                    case MP_BC_MAKE_FUNCTION:
451
452
453
454
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

455
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
456
457
458
459
460
                        DECODE_UINT;
                        obj1 = POP();
                        PUSH(rt_make_closure_from_id(unum, obj1));
                        break;

461
                    case MP_BC_CALL_FUNCTION:
462
                        DECODE_UINT;
463
464
465
466
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe);
                        SET_TOP(rt_call_function_n_kw(*sp, unum & 0xff, (unum >> 8) & 0xff, sp + 1));
467
468
                        break;

469
                    case MP_BC_CALL_METHOD:
470
                        DECODE_UINT;
471
472
473
474
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 1;
                        SET_TOP(rt_call_method_n_kw(unum & 0xff, (unum >> 8) & 0xff, sp));
475
476
                        break;

477
                    case MP_BC_RETURN_VALUE:
478
                        nlr_pop();
479
                        *sp_in_out = sp;
480
                        assert(exc_sp == &exc_stack[0] - 1);
481
482
                        return false;

483
484
485
486
487
488
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
                        assert(unum == 1);
                        obj1 = POP();
                        nlr_jump(obj1);

489
                    case MP_BC_YIELD_VALUE:
490
491
492
                        nlr_pop();
                        *ip_in_out = ip;
                        fastn[0] = fast0;
493
494
                        fastn[-1] = fast1;
                        fastn[-2] = fast2;
495
496
                        *sp_in_out = sp;
                        return true;
497

498
                    case MP_BC_IMPORT_NAME:
499
500
501
502
503
                        DECODE_QSTR;
                        obj1 = POP();
                        SET_TOP(rt_import_name(qstr, obj1, TOP()));
                        break;

504
                    case MP_BC_IMPORT_FROM:
505
506
507
508
509
                        DECODE_QSTR;
                        obj1 = rt_import_from(TOP(), qstr);
                        PUSH(obj1);
                        break;

510
                    default:
Damien's avatar
Damien committed
511
                        printf("code %p, byte code 0x%02x not implemented\n", ip, op);
512
513
                        assert(0);
                        nlr_pop();
514
                        return false;
Damien's avatar
Damien committed
515
                }
516
517
518
519
520
            }

        } else {
            // exception occurred

521
522
523
524
525
526
527
528
529
530
531
532
533
            while (currently_in_except_block) {
                // nested exception

                assert(exc_sp >= &exc_stack[0]);

                // TODO make a proper message for nested exception
                // at the moment we are just raising the very last exception (the one that caused the nested exception)

                // move up to previous exception handler
                currently_in_except_block = (exc_sp[0] & 1); // restore previous state
                exc_sp -= 2; // pop back to previous exception handler
            }

Damien's avatar
Damien committed
534
            if (exc_sp >= &exc_stack[0]) {
535
536
537
                // set flag to indicate that we are now handling an exception
                currently_in_except_block = 1;

538
                // catch exception and pass to byte code
539
                sp = (mp_obj_t*)(exc_sp[0] & (~((machine_uint_t)1)));
Damien's avatar
Damien committed
540
541
                ip = (const byte*)(exc_sp[-1]);
                // push(traceback, exc-val, exc-type)
542
                PUSH(mp_const_none);
Damien's avatar
Damien committed
543
                PUSH(nlr.ret_val);
544
                PUSH(nlr.ret_val); // TODO should be type(nlr.ret_val), I think...
545

546
            } else {
547
                // re-raise exception to higher level
548
                // TODO what to do if this is a generator??
549
550
                nlr_jump(nlr.ret_val);
            }
Damien's avatar
Damien committed
551
552
553
        }
    }
}