vm.c 21.5 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

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

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

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

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

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

76
    const byte *ip = *ip_in_out;
77
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
78
79
    machine_uint_t unum;
    qstr qstr;
80
    mp_obj_t obj1, obj2;
81
    mp_obj_t fast0 = fastn[0], fast1 = fastn[-1], fast2 = fastn[-2];
82
    nlr_buf_t nlr;
Damien's avatar
Damien committed
83

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

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

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

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

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
112

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

119
120
121
122
123
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qstr)));
                        break;

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

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

134
135
136
137
138
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
                        PUSH(rt_load_const_str(qstr)); // TODO
                        break;

139
                    case MP_BC_LOAD_CONST_STRING:
140
141
142
143
                        DECODE_QSTR;
                        PUSH(rt_load_const_str(qstr));
                        break;

144
                    case MP_BC_LOAD_FAST_0:
145
146
147
                        PUSH(fast0);
                        break;

148
                    case MP_BC_LOAD_FAST_1:
149
150
151
                        PUSH(fast1);
                        break;

152
                    case MP_BC_LOAD_FAST_2:
153
154
155
                        PUSH(fast2);
                        break;

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

161
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
162
                        DECODE_UINT;
163
164
165
166
167
168
169
170
171
172
                        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
173
174
                        break;

175
                    case MP_BC_LOAD_NAME:
176
177
178
179
                        DECODE_QSTR;
                        PUSH(rt_load_name(qstr));
                        break;

180
                    case MP_BC_LOAD_GLOBAL:
181
182
183
184
                        DECODE_QSTR;
                        PUSH(rt_load_global(qstr));
                        break;

185
                    case MP_BC_LOAD_ATTR:
186
                        DECODE_QSTR;
187
                        SET_TOP(rt_load_attr(TOP(), qstr));
188
189
                        break;

190
                    case MP_BC_LOAD_METHOD:
191
                        DECODE_QSTR;
192
193
                        rt_load_method(*sp, qstr, sp);
                        sp += 1;
194
195
                        break;

196
                    case MP_BC_LOAD_BUILD_CLASS:
197
198
199
                        PUSH(rt_load_build_class());
                        break;

200
                    case MP_BC_STORE_FAST_0:
201
202
203
                        fast0 = POP();
                        break;

204
                    case MP_BC_STORE_FAST_1:
205
206
207
                        fast1 = POP();
                        break;

208
                    case MP_BC_STORE_FAST_2:
209
210
211
                        fast2 = POP();
                        break;

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

217
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
218
                        DECODE_UINT;
219
220
221
222
223
224
225
226
227
228
                        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
229
230
                        break;

231
                    case MP_BC_STORE_NAME:
232
233
234
235
                        DECODE_QSTR;
                        rt_store_name(qstr, POP());
                        break;

236
                    case MP_BC_STORE_GLOBAL:
237
238
239
240
                        DECODE_QSTR;
                        rt_store_global(qstr, POP());
                        break;

241
                    case MP_BC_STORE_ATTR:
242
                        DECODE_QSTR;
243
244
                        rt_store_attr(sp[0], qstr, sp[-1]);
                        sp -= 2;
245
246
                        break;

247
                    case MP_BC_STORE_SUBSCR:
248
249
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
250
251
                        break;

252
                    case MP_BC_DUP_TOP:
253
                        obj1 = TOP();
254
255
256
                        PUSH(obj1);
                        break;

257
                    case MP_BC_DUP_TOP_TWO:
258
259
260
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
261
262
                        break;

263
                    case MP_BC_POP_TOP:
264
                        sp -= 1;
265
266
                        break;

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

273
                    case MP_BC_ROT_THREE:
274
                        obj1 = sp[0];
275
276
277
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
278
279
                        break;

280
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
281
282
                        DECODE_SLABEL;
                        ip += unum;
283
284
                        break;

285
                    case MP_BC_POP_JUMP_IF_TRUE:
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_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
293
                        DECODE_SLABEL;
294
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
295
                            ip += unum;
296
297
298
                        }
                        break;

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

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

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

Damien's avatar
Damien committed
324
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
325
                    case MP_BC_SETUP_EXCEPT:
Damien's avatar
Damien committed
326
327
                        DECODE_ULABEL; // except labels are always forward
                        *++exc_sp = (machine_uint_t)ip + unum;
328
329
                        *++exc_sp = (((machine_uint_t)sp) | currently_in_except_block);
                        currently_in_except_block = 0; // in a try block now
330
331
                        break;

332
                    case MP_BC_END_FINALLY:
333
334
335
336
337
338
339
340
                        // 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;

341
                    case MP_BC_GET_ITER:
342
                        SET_TOP(rt_getiter(TOP()));
343
344
                        break;

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

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

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

376
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
377
                        unum = *ip++;
378
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
379
380
                        break;

381
                    case MP_BC_BINARY_OP:
382
383
                        unum = *ip++;
                        obj2 = POP();
384
385
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
386
387
                        break;

388
                    case MP_BC_BUILD_TUPLE:
389
                        DECODE_UINT;
390
391
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
392
393
                        break;

394
                    case MP_BC_BUILD_LIST:
395
                        DECODE_UINT;
396
397
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
398
399
                        break;

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

407
                    case MP_BC_BUILD_MAP:
408
409
410
411
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

412
                    case MP_BC_STORE_MAP:
413
414
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
415
416
                        break;

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

424
                    case MP_BC_BUILD_SET:
425
                        DECODE_UINT;
426
427
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
428
429
                        break;

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

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

451
                    case MP_BC_UNPACK_SEQUENCE:
452
                        DECODE_UINT;
453
454
                        rt_unpack_sequence(sp[0], unum, sp + unum - 1);
                        sp += unum - 1;
455
456
                        break;

457
                    case MP_BC_MAKE_FUNCTION:
458
459
460
461
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

462
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
463
464
465
466
467
                        DECODE_UINT;
                        obj1 = POP();
                        PUSH(rt_make_closure_from_id(unum, obj1));
                        break;

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

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

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

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

496
                    case MP_BC_YIELD_VALUE:
497
498
499
                        nlr_pop();
                        *ip_in_out = ip;
                        fastn[0] = fast0;
500
501
                        fastn[-1] = fast1;
                        fastn[-2] = fast2;
502
503
                        *sp_in_out = sp;
                        return true;
504

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

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

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

        } else {
            // exception occurred

528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
            // set file and line number that the exception occurred at
            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);
                qstr = code_info[4] | (code_info[5] << 8) | (code_info[6] << 16) | (code_info[7] << 24);
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
                //printf("find %lu %d %d\n", bc, code_info[8], code_info[9]);
                for (const byte* ci = code_info + 8; bc > ci[0]; ci += 2) {
                    bc -= ci[0];
                    source_line += ci[1];
                    if (ci[0] == 0 && ci[1] == 0) {
                        break;
                    }
                }
                mp_obj_exception_set_source_info(nlr.ret_val, qstr, source_line);
            }

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

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

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