vm.c 22 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
#include "mpconfig.h"
10
#include "qstr.h"
11
#include "obj.h"
Damien's avatar
Damien committed
12
#include "runtime.h"
13
#include "bc0.h"
14
#include "bc.h"
Damien's avatar
Damien committed
15

16
17
18
19
20
21
22
23
24
25
// Exception stack entry
typedef struct _mp_exc_stack {
    const byte *handler;
    // bit 0 is saved currently_in_except_block value
    machine_uint_t val_sp;
    // We might only have 2 interesting cases here: SETUP_EXCEPT & SETUP_FINALLY,
    // consider storing it in bit 1 of val_sp. TODO: SETUP_WITH?
    byte opcode;
} mp_exc_stack;

26
27
28
// (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
29
#define DECODE_UINT do { unum = *ip++; if (unum > 127) { unum = ((unum & 0x3f) << 8) | (*ip++); } } while (0)
Damien's avatar
Damien committed
30
31
#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)
32
#define DECODE_QSTR do { qst = *ip++; if (qst > 127) { qst = ((qst & 0x3f) << 8) | (*ip++); } } while (0)
33
34
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
35
36
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
37

38
mp_obj_t mp_execute_byte_code(const byte *code, const mp_obj_t *args, uint n_args, uint n_state) {
39
40
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
41
    mp_obj_t *state = &temp_state[0];
42
    if (n_state > 10) {
43
        state = m_new(mp_obj_t, n_state);
44
    }
45
46
    mp_obj_t *sp = &state[0] - 1;

47
48
49
    // init args
    for (int i = 0; i < n_args; i++) {
        assert(i < 8);
50
        state[n_state - 1 - i] = args[i];
51
    }
52

53
    const byte *ip = code;
Damien George's avatar
Damien George committed
54

55
56
57
58
    // get code info size
    machine_uint_t code_info_size = ip[0] | (ip[1] << 8) | (ip[2] << 16) | (ip[3] << 24);
    ip += code_info_size;

Damien George's avatar
Damien George committed
59
60
61
62
63
    // 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) {
64
                state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
65
            } else {
66
                state[n_state - 1 - local_num] = mp_obj_new_cell(MP_OBJ_NULL);
Damien George's avatar
Damien George committed
67
68
69
70
71
            }
        }
    }

    // execute the byte code
72
    if (mp_execute_byte_code_2(code, &ip, &state[n_state - 1], &sp)) {
73
74
75
        // it shouldn't yield
        assert(0);
    }
Damien George's avatar
Damien George committed
76

77
78
    // TODO check fails if, eg, return from within for loop
    //assert(sp == &state[17]);
79
80
81
    return *sp;
}

82
83
// 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
84
// returns true if bytecode yielded
85
bool mp_execute_byte_code_2(const byte *code_info, const byte **ip_in_out, mp_obj_t *fastn, mp_obj_t **sp_in_out) {
Damien's avatar
Damien committed
86
87
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

88
    const byte *ip = *ip_in_out;
89
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
90
    machine_uint_t unum;
91
    qstr qst;
92
    mp_obj_t obj1, obj2;
93
    nlr_buf_t nlr;
Damien's avatar
Damien committed
94

95
    volatile machine_uint_t currently_in_except_block = 0; // 0 or 1, to detect nested exceptions
96
97
    mp_exc_stack exc_stack[4];
    mp_exc_stack *volatile exc_sp = &exc_stack[0] - 1; // stack grows up, exc_sp points to top of stack
98
    const byte *volatile save_ip = ip; // this is so we can access ip in the exception handler without making ip volatile (which means the compiler can't keep it in a register in the main loop)
Damien's avatar
Damien committed
99

100
    // outer exception handling loop
Damien's avatar
Damien committed
101
    for (;;) {
102
103
104
        if (nlr_push(&nlr) == 0) {
            // loop to execute byte code
            for (;;) {
105
                save_ip = ip;
106
107
                int op = *ip++;
                switch (op) {
108
109
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
110
111
                        break;

112
113
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
114
115
                        break;

116
117
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
118
                        break;
Damien George's avatar
Damien George committed
119
120
121
122

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
123

124
                    case MP_BC_LOAD_CONST_SMALL_INT:
Damien's avatar
Damien committed
125
                        unum = (ip[0] | (ip[1] << 8) | (ip[2] << 16)) - 0x800000;
126
                        ip += 3;
127
                        PUSH(MP_OBJ_NEW_SMALL_INT(unum));
128
129
                        break;

130
131
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
132
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
133
134
                        break;

135
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
136
                        DECODE_QSTR;
137
                        PUSH(rt_load_const_dec(qst));
Damien's avatar
Damien committed
138
139
                        break;

140
                    case MP_BC_LOAD_CONST_ID:
141
                        DECODE_QSTR;
142
                        PUSH(rt_load_const_str(qst)); // TODO
143
144
                        break;

145
146
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
147
                        PUSH(rt_load_const_bytes(qst));
148
149
                        break;

150
                    case MP_BC_LOAD_CONST_STRING:
151
                        DECODE_QSTR;
152
                        PUSH(rt_load_const_str(qst));
153
154
                        break;

155
                    case MP_BC_LOAD_FAST_0:
156
                        PUSH(fastn[0]);
157
158
                        break;

159
                    case MP_BC_LOAD_FAST_1:
160
                        PUSH(fastn[-1]);
161
162
                        break;

163
                    case MP_BC_LOAD_FAST_2:
164
                        PUSH(fastn[-2]);
165
166
                        break;

167
                    case MP_BC_LOAD_FAST_N:
168
                        DECODE_UINT;
169
                        PUSH(fastn[-unum]);
170
171
                        break;

172
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
173
                        DECODE_UINT;
174
                        PUSH(rt_get_cell(fastn[-unum]));
Damien's avatar
Damien committed
175
176
                        break;

177
                    case MP_BC_LOAD_NAME:
178
                        DECODE_QSTR;
179
                        PUSH(rt_load_name(qst));
180
181
                        break;

182
                    case MP_BC_LOAD_GLOBAL:
183
                        DECODE_QSTR;
184
                        PUSH(rt_load_global(qst));
185
186
                        break;

187
                    case MP_BC_LOAD_ATTR:
188
                        DECODE_QSTR;
189
                        SET_TOP(rt_load_attr(TOP(), qst));
190
191
                        break;

192
                    case MP_BC_LOAD_METHOD:
193
                        DECODE_QSTR;
194
                        rt_load_method(*sp, qst, sp);
195
                        sp += 1;
196
197
                        break;

198
                    case MP_BC_LOAD_BUILD_CLASS:
199
200
201
                        PUSH(rt_load_build_class());
                        break;

202
                    case MP_BC_STORE_FAST_0:
203
                        fastn[0] = POP();
204
205
                        break;

206
                    case MP_BC_STORE_FAST_1:
207
                        fastn[-1] = POP();
208
209
                        break;

210
                    case MP_BC_STORE_FAST_2:
211
                        fastn[-2] = POP();
212
213
                        break;

214
                    case MP_BC_STORE_FAST_N:
215
                        DECODE_UINT;
216
                        fastn[-unum] = POP();
217
218
                        break;

219
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
220
                        DECODE_UINT;
221
                        rt_set_cell(fastn[-unum], POP());
Damien's avatar
Damien committed
222
223
                        break;

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

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

234
                    case MP_BC_STORE_ATTR:
235
                        DECODE_QSTR;
236
                        rt_store_attr(sp[0], qst, sp[-1]);
237
                        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;
                        */

317
318
319
320
321
322
323
324
325
326
327
328
                    // TODO this might need more sophisticated handling when breaking from within an except
                    case MP_BC_BREAK_LOOP:
                        DECODE_ULABEL;
                        ip += unum;
                        break;

                    // TODO this might need more sophisticated handling when breaking from within an except
                    case MP_BC_CONTINUE_LOOP:
                        DECODE_ULABEL;
                        ip += unum;
                        break;

Damien's avatar
Damien committed
329
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
330
                    case MP_BC_SETUP_EXCEPT:
331
                    case MP_BC_SETUP_FINALLY:
Damien's avatar
Damien committed
332
                        DECODE_ULABEL; // except labels are always forward
333
334
335
336
                        ++exc_sp;
                        exc_sp->opcode = op;
                        exc_sp->handler = ip + unum;
                        exc_sp->val_sp = (((machine_uint_t)sp) | currently_in_except_block);
337
                        currently_in_except_block = 0; // in a try block now
338
339
                        break;

340
                    case MP_BC_END_FINALLY:
341
                        // not fully implemented
342
343
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
344
                        // if TOS is an integer, does something else
345
                        // else error
346
347
348
349
350
351
352
353
                        if (MP_OBJ_IS_TYPE(TOP(), &exception_type)) {
                            nlr_jump(TOP());
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
                        } else {
                            assert(0);
                        }
354
355
                        break;

356
                    case MP_BC_GET_ITER:
357
                        SET_TOP(rt_getiter(TOP()));
358
359
                        break;

360
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
361
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
362
                        obj1 = rt_iternext(TOP());
363
                        if (obj1 == mp_const_stop_iteration) {
364
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
365
                            ip += unum; // jump to after for-block
366
367
368
369
370
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
371
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
372
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
373
374
                        // we are exiting an exception handler, so pop the last one of the exception-stack
                        assert(exc_sp >= &exc_stack[0]);
375
376
                        currently_in_except_block = (exc_sp->val_sp & 1); // restore previous state
                        exc_sp--; // pop back to previous exception handler
377
378
                        break;

379
                    // matched against: SETUP_EXCEPT
380
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
381
                        // TODO need to work out how blocks work etc
382
                        // 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
383
                        assert(exc_sp >= &exc_stack[0]);
384
                        assert(currently_in_except_block);
385
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
386
                        //exc_sp--; // discard ip
387
388
                        currently_in_except_block = (exc_sp->val_sp & 1); // restore previous state
                        exc_sp--; // pop back to previous exception handler
389
                        //sp -= 3; // pop 3 exception values
390
391
                        break;

392
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
393
                        unum = *ip++;
394
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
395
396
                        break;

397
                    case MP_BC_BINARY_OP:
398
399
                        unum = *ip++;
                        obj2 = POP();
400
401
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
402
403
                        break;

404
                    case MP_BC_BUILD_TUPLE:
405
                        DECODE_UINT;
406
407
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
408
409
                        break;

410
                    case MP_BC_BUILD_LIST:
411
                        DECODE_UINT;
412
413
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
414
415
                        break;

416
                    case MP_BC_LIST_APPEND:
417
418
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
419
420
                        rt_list_append(sp[-unum], sp[0]);
                        sp--;
421
422
                        break;

423
                    case MP_BC_BUILD_MAP:
424
425
426
427
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

428
                    case MP_BC_STORE_MAP:
429
430
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
431
432
                        break;

433
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
434
                        DECODE_UINT;
435
436
437
                        // 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
438
439
                        break;

440
                    case MP_BC_BUILD_SET:
441
                        DECODE_UINT;
442
443
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
444
445
                        break;

446
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
447
                        DECODE_UINT;
448
449
450
                        // 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
451
452
                        break;

453
#if MICROPY_ENABLE_SLICE
454
455
456
457
458
459
460
461
462
463
464
                    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;
465
#endif
466

467
                    case MP_BC_UNPACK_SEQUENCE:
468
                        DECODE_UINT;
469
                        rt_unpack_sequence(sp[0], unum, sp);
470
                        sp += unum - 1;
471
472
                        break;

473
                    case MP_BC_MAKE_FUNCTION:
474
475
476
477
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

478
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
479
                        DECODE_UINT;
480
                        SET_TOP(rt_make_closure_from_id(unum, TOP()));
Damien's avatar
Damien committed
481
482
                        break;

483
                    case MP_BC_CALL_FUNCTION:
484
                        DECODE_UINT;
485
486
487
488
                        // 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));
489
490
                        break;

491
                    case MP_BC_CALL_METHOD:
492
                        DECODE_UINT;
493
494
495
496
                        // 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));
497
498
                        break;

499
                    case MP_BC_RETURN_VALUE:
500
                        nlr_pop();
501
                        *sp_in_out = sp;
502
                        assert(exc_sp == &exc_stack[0] - 1);
503
504
                        return false;

505
506
507
508
509
510
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
                        assert(unum == 1);
                        obj1 = POP();
                        nlr_jump(obj1);

511
                    case MP_BC_YIELD_VALUE:
512
513
514
515
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
                        return true;
516

517
                    case MP_BC_IMPORT_NAME:
518
519
                        DECODE_QSTR;
                        obj1 = POP();
520
                        SET_TOP(rt_import_name(qst, obj1, TOP()));
521
522
                        break;

523
                    case MP_BC_IMPORT_FROM:
524
                        DECODE_QSTR;
525
                        obj1 = rt_import_from(TOP(), qst);
526
527
528
                        PUSH(obj1);
                        break;

529
                    default:
Damien's avatar
Damien committed
530
                        printf("code %p, byte code 0x%02x not implemented\n", ip, op);
531
532
                        assert(0);
                        nlr_pop();
533
                        return false;
Damien's avatar
Damien committed
534
                }
535
536
537
538
539
            }

        } else {
            // exception occurred

540
            // set file and line number that the exception occurred at
541
542
            // TODO: don't set traceback for exceptions re-raised by END_FINALLY.
            // But consider how to handle nested exceptions.
543
544
            if (MP_OBJ_IS_TYPE(nlr.ret_val, &exception_type)) {
                machine_uint_t code_info_size = code_info[0] | (code_info[1] << 8) | (code_info[2] << 16) | (code_info[3] << 24);
545
546
                qstr source_file = code_info[4] | (code_info[5] << 8) | (code_info[6] << 16) | (code_info[7] << 24);
                qstr block_name = code_info[8] | (code_info[9] << 8) | (code_info[10] << 16) | (code_info[11] << 24);
547
548
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
549
                //printf("find %lu %d %d\n", bc, code_info[12], code_info[13]);
550
551
552
                for (const byte* ci = code_info + 12; *ci && bc >= ((*ci) & 31); ci++) {
                    bc -= *ci & 31;
                    source_line += *ci >> 5;
553
                }
554
                mp_obj_exception_add_traceback(nlr.ret_val, source_file, source_line, block_name);
555
556
            }

557
558
559
560
561
562
563
564
565
            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
566
567
                currently_in_except_block = (exc_sp->val_sp & 1); // restore previous state
                exc_sp--; // pop back to previous exception handler
568
569
            }

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

574
                // catch exception and pass to byte code
575
576
                sp = (mp_obj_t*)(exc_sp->val_sp & (~((machine_uint_t)1)));
                ip = exc_sp->handler;
Damien's avatar
Damien committed
577
                // push(traceback, exc-val, exc-type)
578
                PUSH(mp_const_none);
Damien's avatar
Damien committed
579
                PUSH(nlr.ret_val);
580
                PUSH(nlr.ret_val); // TODO should be type(nlr.ret_val), I think...
581

582
            } else {
583
                // re-raise exception to higher level
584
                // TODO what to do if this is a generator??
585
586
                nlr_jump(nlr.ret_val);
            }
Damien's avatar
Damien committed
587
588
589
        }
    }
}