vm.c 21.6 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
// (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
19
#define DECODE_UINT do { unum = *ip++; if (unum > 127) { unum = ((unum & 0x3f) << 8) | (*ip++); } } while (0)
Damien's avatar
Damien committed
20
21
#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)
22
#define DECODE_QSTR do { qst = *ip++; if (qst > 127) { qst = ((qst & 0x3f) << 8) | (*ip++); } } while (0)
23
24
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
25
26
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
27

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

37
38
39
    // init args
    for (int i = 0; i < n_args; i++) {
        assert(i < 8);
40
        state[n_state - 1 - i] = args[i];
41
    }
42

43
    const byte *ip = code;
Damien George's avatar
Damien George committed
44

45
46
47
48
    // 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
49
50
51
52
53
    // 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) {
54
                state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
55
            } else {
56
                state[n_state - 1 - local_num] = mp_obj_new_cell(MP_OBJ_NULL);
Damien George's avatar
Damien George committed
57
58
59
60
61
            }
        }
    }

    // execute the byte code
62
    if (mp_execute_byte_code_2(code, &ip, &state[n_state - 1], &sp)) {
63
64
65
        // it shouldn't yield
        assert(0);
    }
Damien George's avatar
Damien George committed
66

67
68
    // TODO check fails if, eg, return from within for loop
    //assert(sp == &state[17]);
69
70
71
    return *sp;
}

72
73
// 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
74
// returns true if bytecode yielded
75
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
76
77
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

78
    const byte *ip = *ip_in_out;
79
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
80
    machine_uint_t unum;
81
    qstr qst;
82
    mp_obj_t obj1, obj2;
83
    nlr_buf_t nlr;
Damien's avatar
Damien committed
84

85
86
    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
87
    machine_uint_t *volatile exc_sp = &exc_stack[0] - 1; // stack grows up, exc_sp points to top of stack
88
    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
89

90
    // outer exception handling loop
Damien's avatar
Damien committed
91
    for (;;) {
92
93
94
        if (nlr_push(&nlr) == 0) {
            // loop to execute byte code
            for (;;) {
95
                save_ip = ip;
96
97
                int op = *ip++;
                switch (op) {
98
99
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
100
101
                        break;

102
103
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
104
105
                        break;

106
107
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
108
                        break;
Damien George's avatar
Damien George committed
109
110
111
112

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
113

114
                    case MP_BC_LOAD_CONST_SMALL_INT:
Damien's avatar
Damien committed
115
                        unum = (ip[0] | (ip[1] << 8) | (ip[2] << 16)) - 0x800000;
116
                        ip += 3;
117
                        PUSH(MP_OBJ_NEW_SMALL_INT(unum));
118
119
                        break;

120
121
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
122
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
123
124
                        break;

125
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
126
                        DECODE_QSTR;
127
                        PUSH(rt_load_const_dec(qst));
Damien's avatar
Damien committed
128
129
                        break;

130
                    case MP_BC_LOAD_CONST_ID:
131
                        DECODE_QSTR;
132
                        PUSH(rt_load_const_str(qst)); // TODO
133
134
                        break;

135
136
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
137
                        PUSH(rt_load_const_bytes(qst));
138
139
                        break;

140
                    case MP_BC_LOAD_CONST_STRING:
141
                        DECODE_QSTR;
142
                        PUSH(rt_load_const_str(qst));
143
144
                        break;

145
                    case MP_BC_LOAD_FAST_0:
146
                        PUSH(fastn[0]);
147
148
                        break;

149
                    case MP_BC_LOAD_FAST_1:
150
                        PUSH(fastn[-1]);
151
152
                        break;

153
                    case MP_BC_LOAD_FAST_2:
154
                        PUSH(fastn[-2]);
155
156
                        break;

157
                    case MP_BC_LOAD_FAST_N:
158
                        DECODE_UINT;
159
                        PUSH(fastn[-unum]);
160
161
                        break;

162
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
163
                        DECODE_UINT;
164
                        PUSH(rt_get_cell(fastn[-unum]));
Damien's avatar
Damien committed
165
166
                        break;

167
                    case MP_BC_LOAD_NAME:
168
                        DECODE_QSTR;
169
                        PUSH(rt_load_name(qst));
170
171
                        break;

172
                    case MP_BC_LOAD_GLOBAL:
173
                        DECODE_QSTR;
174
                        PUSH(rt_load_global(qst));
175
176
                        break;

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

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

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

192
                    case MP_BC_STORE_FAST_0:
193
                        fastn[0] = POP();
194
195
                        break;

196
                    case MP_BC_STORE_FAST_1:
197
                        fastn[-1] = POP();
198
199
                        break;

200
                    case MP_BC_STORE_FAST_2:
201
                        fastn[-2] = POP();
202
203
                        break;

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

209
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
210
                        DECODE_UINT;
211
                        rt_set_cell(fastn[-unum], POP());
Damien's avatar
Damien committed
212
213
                        break;

214
                    case MP_BC_STORE_NAME:
215
                        DECODE_QSTR;
216
                        rt_store_name(qst, POP());
217
218
                        break;

219
                    case MP_BC_STORE_GLOBAL:
220
                        DECODE_QSTR;
221
                        rt_store_global(qst, POP());
222
223
                        break;

224
                    case MP_BC_STORE_ATTR:
225
                        DECODE_QSTR;
226
                        rt_store_attr(sp[0], qst, sp[-1]);
227
                        sp -= 2;
228
229
                        break;

230
                    case MP_BC_STORE_SUBSCR:
231
232
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
233
234
                        break;

235
                    case MP_BC_DUP_TOP:
236
                        obj1 = TOP();
237
238
239
                        PUSH(obj1);
                        break;

240
                    case MP_BC_DUP_TOP_TWO:
241
242
243
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
244
245
                        break;

246
                    case MP_BC_POP_TOP:
247
                        sp -= 1;
248
249
                        break;

250
                    case MP_BC_ROT_TWO:
251
                        obj1 = sp[0];
252
253
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
254
255
                        break;

256
                    case MP_BC_ROT_THREE:
257
                        obj1 = sp[0];
258
259
260
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
261
262
                        break;

263
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
264
265
                        DECODE_SLABEL;
                        ip += unum;
266
267
                        break;

268
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
269
                        DECODE_SLABEL;
270
                        if (rt_is_true(POP())) {
Damien's avatar
Damien committed
271
                            ip += unum;
272
273
274
                        }
                        break;

275
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
276
                        DECODE_SLABEL;
277
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
278
                            ip += unum;
279
280
281
                        }
                        break;

282
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
283
                        DECODE_SLABEL;
284
                        if (rt_is_true(TOP())) {
Damien's avatar
Damien committed
285
286
                            ip += unum;
                        } else {
287
                            sp--;
Damien's avatar
Damien committed
288
289
290
                        }
                        break;

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

300
                        /* we are trying to get away without using this opcode
301
                    case MP_BC_SETUP_LOOP:
302
                        DECODE_UINT;
303
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
304
305
306
                        break;
                        */

307
308
309
310
311
312
313
314
315
316
317
318
                    // 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
319
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
320
                    case MP_BC_SETUP_EXCEPT:
Damien's avatar
Damien committed
321
322
                        DECODE_ULABEL; // except labels are always forward
                        *++exc_sp = (machine_uint_t)ip + unum;
323
324
                        *++exc_sp = (((machine_uint_t)sp) | currently_in_except_block);
                        currently_in_except_block = 0; // in a try block now
325
326
                        break;

327
                    case MP_BC_END_FINALLY:
328
                        // not fully implemented
329
330
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
331
                        // if TOS is an integer, does something else
332
                        // else error
333
334
335
336
337
338
339
340
                        if (MP_OBJ_IS_TYPE(TOP(), &exception_type)) {
                            nlr_jump(TOP());
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
                        } else {
                            assert(0);
                        }
341
342
                        break;

343
                    case MP_BC_GET_ITER:
344
                        SET_TOP(rt_getiter(TOP()));
345
346
                        break;

347
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
348
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
349
                        obj1 = rt_iternext(TOP());
350
                        if (obj1 == mp_const_stop_iteration) {
351
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
352
                            ip += unum; // jump to after for-block
353
354
355
356
357
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
358
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
359
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
360
361
362
363
                        // 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
364
365
                        break;

366
                    // matched against: SETUP_EXCEPT
367
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
368
                        // TODO need to work out how blocks work etc
369
                        // 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
370
                        assert(exc_sp >= &exc_stack[0]);
371
                        assert(currently_in_except_block);
372
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
373
                        //exc_sp--; // discard ip
374
375
                        currently_in_except_block = (exc_sp[0] & 1); // restore previous state
                        exc_sp -= 2; // pop back to previous exception handler
376
                        //sp -= 3; // pop 3 exception values
377
378
                        break;

379
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
380
                        unum = *ip++;
381
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
382
383
                        break;

384
                    case MP_BC_BINARY_OP:
385
386
                        unum = *ip++;
                        obj2 = POP();
387
388
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
389
390
                        break;

391
                    case MP_BC_BUILD_TUPLE:
392
                        DECODE_UINT;
393
394
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
395
396
                        break;

397
                    case MP_BC_BUILD_LIST:
398
                        DECODE_UINT;
399
400
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
401
402
                        break;

403
                    case MP_BC_LIST_APPEND:
404
405
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
406
407
                        rt_list_append(sp[-unum], sp[0]);
                        sp--;
408
409
                        break;

410
                    case MP_BC_BUILD_MAP:
411
412
413
414
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

415
                    case MP_BC_STORE_MAP:
416
417
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
418
419
                        break;

420
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
421
                        DECODE_UINT;
422
423
424
                        // 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
425
426
                        break;

427
                    case MP_BC_BUILD_SET:
428
                        DECODE_UINT;
429
430
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
431
432
                        break;

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

440
#if MICROPY_ENABLE_SLICE
441
442
443
444
445
446
447
448
449
450
451
                    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;
452
#endif
453

454
                    case MP_BC_UNPACK_SEQUENCE:
455
                        DECODE_UINT;
456
                        rt_unpack_sequence(sp[0], unum, sp);
457
                        sp += unum - 1;
458
459
                        break;

460
                    case MP_BC_MAKE_FUNCTION:
461
462
463
464
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

465
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
466
                        DECODE_UINT;
467
                        SET_TOP(rt_make_closure_from_id(unum, TOP()));
Damien's avatar
Damien committed
468
469
                        break;

470
                    case MP_BC_CALL_FUNCTION:
471
                        DECODE_UINT;
472
473
474
475
                        // 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));
476
477
                        break;

478
                    case MP_BC_CALL_METHOD:
479
                        DECODE_UINT;
480
481
482
483
                        // 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));
484
485
                        break;

486
                    case MP_BC_RETURN_VALUE:
487
                        nlr_pop();
488
                        *sp_in_out = sp;
489
                        assert(exc_sp == &exc_stack[0] - 1);
490
491
                        return false;

492
493
494
495
496
497
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
                        assert(unum == 1);
                        obj1 = POP();
                        nlr_jump(obj1);

498
                    case MP_BC_YIELD_VALUE:
499
500
501
502
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
                        return true;
503

504
                    case MP_BC_IMPORT_NAME:
505
506
                        DECODE_QSTR;
                        obj1 = POP();
507
                        SET_TOP(rt_import_name(qst, obj1, TOP()));
508
509
                        break;

510
                    case MP_BC_IMPORT_FROM:
511
                        DECODE_QSTR;
512
                        obj1 = rt_import_from(TOP(), qst);
513
514
515
                        PUSH(obj1);
                        break;

516
                    default:
Damien's avatar
Damien committed
517
                        printf("code %p, byte code 0x%02x not implemented\n", ip, op);
518
519
                        assert(0);
                        nlr_pop();
520
                        return false;
Damien's avatar
Damien committed
521
                }
522
523
524
525
526
            }

        } else {
            // exception occurred

527
            // set file and line number that the exception occurred at
528
529
            // TODO: don't set traceback for exceptions re-raised by END_FINALLY.
            // But consider how to handle nested exceptions.
530
531
            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);
532
533
                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);
534
535
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
536
                //printf("find %lu %d %d\n", bc, code_info[12], code_info[13]);
537
538
539
                for (const byte* ci = code_info + 12; *ci && bc >= ((*ci) & 31); ci++) {
                    bc -= *ci & 31;
                    source_line += *ci >> 5;
540
                }
541
                mp_obj_exception_add_traceback(nlr.ret_val, source_file, source_line, block_name);
542
543
            }

544
545
546
547
548
549
550
551
552
553
554
555
556
            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
557
            if (exc_sp >= &exc_stack[0]) {
558
559
560
                // set flag to indicate that we are now handling an exception
                currently_in_except_block = 1;

561
                // catch exception and pass to byte code
562
                sp = (mp_obj_t*)(exc_sp[0] & (~((machine_uint_t)1)));
Damien's avatar
Damien committed
563
564
                ip = (const byte*)(exc_sp[-1]);
                // push(traceback, exc-val, exc-type)
565
                PUSH(mp_const_none);
Damien's avatar
Damien committed
566
                PUSH(nlr.ret_val);
567
                PUSH(nlr.ret_val); // TODO should be type(nlr.ret_val), I think...
568

569
            } else {
570
                // re-raise exception to higher level
571
                // TODO what to do if this is a generator??
572
573
                nlr_jump(nlr.ret_val);
            }
Damien's avatar
Damien committed
574
575
576
        }
    }
}