vm.c 22.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
#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

Paul Sokolovsky's avatar
Paul Sokolovsky committed
16
17
18
19
20
21
22
// Value stack grows up (this makes it incompatible with native C stack, but
// makes sure that arguments to functions are in natural order arg1..argN
// (Python semantics mandates left-to-right evaluation order, including for
// function arguments). Stack pointer is pre-incremented and points at the
// top element.
// Exception stack also grows up, top element is also pointed at.

23
24
25
26
27
28
29
30
31
32
// 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;

Damien's avatar
Damien committed
33
#define DECODE_UINT do { unum = *ip++; if (unum > 127) { unum = ((unum & 0x3f) << 8) | (*ip++); } } while (0)
Damien's avatar
Damien committed
34
35
#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)
36
#define DECODE_QSTR do { qst = *ip++; if (qst > 127) { qst = ((qst & 0x3f) << 8) | (*ip++); } } while (0)
37
38
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
39
40
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
41

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

51
52
53
    // init args
    for (int i = 0; i < n_args; i++) {
        assert(i < 8);
54
        state[n_state - 1 - i] = args[i];
55
    }
56

57
    const byte *ip = code;
Damien George's avatar
Damien George committed
58

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

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

81
82
    // TODO check fails if, eg, return from within for loop
    //assert(sp == &state[17]);
83
84
85
    return *sp;
}

86
87
// 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
88
// returns true if bytecode yielded
89
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
90
91
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

92
    const byte *ip = *ip_in_out;
93
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
94
    machine_uint_t unum;
95
    qstr qst;
96
    mp_obj_t obj1, obj2;
97
    nlr_buf_t nlr;
Damien's avatar
Damien committed
98

99
    volatile machine_uint_t currently_in_except_block = 0; // 0 or 1, to detect nested exceptions
100
101
    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
102
    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
103

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

116
117
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
118
119
                        break;

120
121
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
122
                        break;
Damien George's avatar
Damien George committed
123
124
125
126

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
127

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

134
135
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
136
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
137
138
                        break;

139
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
140
                        DECODE_QSTR;
141
                        PUSH(rt_load_const_dec(qst));
Damien's avatar
Damien committed
142
143
                        break;

144
                    case MP_BC_LOAD_CONST_ID:
145
                        DECODE_QSTR;
146
                        PUSH(rt_load_const_str(qst)); // TODO
147
148
                        break;

149
150
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
151
                        PUSH(rt_load_const_bytes(qst));
152
153
                        break;

154
                    case MP_BC_LOAD_CONST_STRING:
155
                        DECODE_QSTR;
156
                        PUSH(rt_load_const_str(qst));
157
158
                        break;

159
                    case MP_BC_LOAD_FAST_0:
160
                        PUSH(fastn[0]);
161
162
                        break;

163
                    case MP_BC_LOAD_FAST_1:
164
                        PUSH(fastn[-1]);
165
166
                        break;

167
                    case MP_BC_LOAD_FAST_2:
168
                        PUSH(fastn[-2]);
169
170
                        break;

171
                    case MP_BC_LOAD_FAST_N:
172
                        DECODE_UINT;
173
                        PUSH(fastn[-unum]);
174
175
                        break;

176
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
177
                        DECODE_UINT;
178
                        PUSH(rt_get_cell(fastn[-unum]));
Damien's avatar
Damien committed
179
180
                        break;

181
                    case MP_BC_LOAD_NAME:
182
                        DECODE_QSTR;
183
                        PUSH(rt_load_name(qst));
184
185
                        break;

186
                    case MP_BC_LOAD_GLOBAL:
187
                        DECODE_QSTR;
188
                        PUSH(rt_load_global(qst));
189
190
                        break;

191
                    case MP_BC_LOAD_ATTR:
192
                        DECODE_QSTR;
193
                        SET_TOP(rt_load_attr(TOP(), qst));
194
195
                        break;

196
                    case MP_BC_LOAD_METHOD:
197
                        DECODE_QSTR;
198
                        rt_load_method(*sp, qst, sp);
199
                        sp += 1;
200
201
                        break;

202
                    case MP_BC_LOAD_BUILD_CLASS:
203
204
205
                        PUSH(rt_load_build_class());
                        break;

206
                    case MP_BC_STORE_FAST_0:
207
                        fastn[0] = POP();
208
209
                        break;

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

214
                    case MP_BC_STORE_FAST_2:
215
                        fastn[-2] = POP();
216
217
                        break;

218
                    case MP_BC_STORE_FAST_N:
219
                        DECODE_UINT;
220
                        fastn[-unum] = POP();
221
222
                        break;

223
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
224
                        DECODE_UINT;
225
                        rt_set_cell(fastn[-unum], POP());
Damien's avatar
Damien committed
226
227
                        break;

228
                    case MP_BC_STORE_NAME:
229
                        DECODE_QSTR;
230
                        rt_store_name(qst, POP());
231
232
                        break;

233
                    case MP_BC_STORE_GLOBAL:
234
                        DECODE_QSTR;
235
                        rt_store_global(qst, POP());
236
237
                        break;

238
                    case MP_BC_STORE_ATTR:
239
                        DECODE_QSTR;
240
                        rt_store_attr(sp[0], qst, sp[-1]);
241
                        sp -= 2;
242
243
                        break;

244
                    case MP_BC_STORE_SUBSCR:
245
246
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
247
248
                        break;

249
                    case MP_BC_DUP_TOP:
250
                        obj1 = TOP();
251
252
253
                        PUSH(obj1);
                        break;

254
                    case MP_BC_DUP_TOP_TWO:
255
256
257
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
258
259
                        break;

260
                    case MP_BC_POP_TOP:
261
                        sp -= 1;
262
263
                        break;

264
                    case MP_BC_ROT_TWO:
265
                        obj1 = sp[0];
266
267
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
268
269
                        break;

270
                    case MP_BC_ROT_THREE:
271
                        obj1 = sp[0];
272
273
274
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
275
276
                        break;

277
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
278
279
                        DECODE_SLABEL;
                        ip += unum;
280
281
                        break;

282
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
283
                        DECODE_SLABEL;
284
                        if (rt_is_true(POP())) {
Damien's avatar
Damien committed
285
                            ip += unum;
286
287
288
                        }
                        break;

289
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
290
                        DECODE_SLABEL;
291
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
292
                            ip += unum;
293
294
295
                        }
                        break;

296
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
297
                        DECODE_SLABEL;
298
                        if (rt_is_true(TOP())) {
Damien's avatar
Damien committed
299
300
                            ip += unum;
                        } else {
301
                            sp--;
Damien's avatar
Damien committed
302
303
304
                        }
                        break;

305
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
306
                        DECODE_SLABEL;
307
                        if (rt_is_true(TOP())) {
308
                            sp--;
Damien's avatar
Damien committed
309
310
311
312
313
                        } else {
                            ip += unum;
                        }
                        break;

314
                        /* we are trying to get away without using this opcode
315
                    case MP_BC_SETUP_LOOP:
316
                        DECODE_UINT;
317
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
318
319
320
                        break;
                        */

321
322
323
324
325
326
327
328
329
330
331
332
                    // 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
333
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
334
                    case MP_BC_SETUP_EXCEPT:
335
                    case MP_BC_SETUP_FINALLY:
Damien's avatar
Damien committed
336
                        DECODE_ULABEL; // except labels are always forward
337
338
339
340
                        ++exc_sp;
                        exc_sp->opcode = op;
                        exc_sp->handler = ip + unum;
                        exc_sp->val_sp = (((machine_uint_t)sp) | currently_in_except_block);
341
                        currently_in_except_block = 0; // in a try block now
342
343
                        break;

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

360
                    case MP_BC_GET_ITER:
361
                        SET_TOP(rt_getiter(TOP()));
362
363
                        break;

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

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

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

396
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
397
                        unum = *ip++;
398
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
399
400
                        break;

401
                    case MP_BC_BINARY_OP:
402
403
                        unum = *ip++;
                        obj2 = POP();
404
405
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
406
407
                        break;

408
                    case MP_BC_BUILD_TUPLE:
409
                        DECODE_UINT;
410
411
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
412
413
                        break;

414
                    case MP_BC_BUILD_LIST:
415
                        DECODE_UINT;
416
417
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
418
419
                        break;

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

427
                    case MP_BC_BUILD_MAP:
428
429
430
431
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

432
                    case MP_BC_STORE_MAP:
433
434
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
435
436
                        break;

437
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
438
                        DECODE_UINT;
439
440
441
                        // 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
442
443
                        break;

444
                    case MP_BC_BUILD_SET:
445
                        DECODE_UINT;
446
447
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
448
449
                        break;

450
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
451
                        DECODE_UINT;
452
453
454
                        // 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
455
456
                        break;

457
#if MICROPY_ENABLE_SLICE
458
459
460
461
462
463
464
465
466
467
468
                    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;
469
#endif
470

471
                    case MP_BC_UNPACK_SEQUENCE:
472
                        DECODE_UINT;
473
                        rt_unpack_sequence(sp[0], unum, sp);
474
                        sp += unum - 1;
475
476
                        break;

477
                    case MP_BC_MAKE_FUNCTION:
478
479
480
481
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

482
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
483
                        DECODE_UINT;
484
                        SET_TOP(rt_make_closure_from_id(unum, TOP()));
Damien's avatar
Damien committed
485
486
                        break;

487
                    case MP_BC_CALL_FUNCTION:
488
                        DECODE_UINT;
489
490
491
492
                        // 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));
493
494
                        break;

495
                    case MP_BC_CALL_METHOD:
496
                        DECODE_UINT;
497
498
499
500
                        // 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));
501
502
                        break;

503
                    case MP_BC_RETURN_VALUE:
504
                        nlr_pop();
505
                        *sp_in_out = sp;
506
                        assert(exc_sp == &exc_stack[0] - 1);
507
508
                        return false;

509
510
511
512
513
514
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
                        assert(unum == 1);
                        obj1 = POP();
                        nlr_jump(obj1);

515
                    case MP_BC_YIELD_VALUE:
516
517
518
519
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
                        return true;
520

521
                    case MP_BC_IMPORT_NAME:
522
523
                        DECODE_QSTR;
                        obj1 = POP();
524
                        SET_TOP(rt_import_name(qst, obj1, TOP()));
525
526
                        break;

527
                    case MP_BC_IMPORT_FROM:
528
                        DECODE_QSTR;
529
                        obj1 = rt_import_from(TOP(), qst);
530
531
532
                        PUSH(obj1);
                        break;

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

        } else {
            // exception occurred

544
            // set file and line number that the exception occurred at
545
546
            // TODO: don't set traceback for exceptions re-raised by END_FINALLY.
            // But consider how to handle nested exceptions.
547
548
            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);
549
550
                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);
551
552
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
553
                //printf("find %lu %d %d\n", bc, code_info[12], code_info[13]);
554
555
556
                for (const byte* ci = code_info + 12; *ci && bc >= ((*ci) & 31); ci++) {
                    bc -= *ci & 31;
                    source_line += *ci >> 5;
557
                }
558
                mp_obj_exception_add_traceback(nlr.ret_val, source_file, source_line, block_name);
559
560
            }

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

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

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

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