vm.c 21.8 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
    n_state += 1; // XXX there is a bug somewhere which doesn't count enough state... (conwaylife and mandel have the bug)

31
32
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
33
    mp_obj_t *state = &temp_state[0];
34
    if (n_state > 10) {
35
        state = m_new(mp_obj_t, n_state);
36
    }
37
38
    mp_obj_t *sp = &state[0] - 1;

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

45
    const byte *ip = code;
Damien George's avatar
Damien George committed
46

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

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

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

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

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

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

92
93
    // TODO if an exception occurs, do fast[0,1,2] become invalid??

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

106
107
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
108
109
                        break;

110
111
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
112
                        break;
Damien George's avatar
Damien George committed
113
114
115
116

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
117

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

124
125
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
126
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
127
128
                        break;

129
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
130
                        DECODE_QSTR;
131
                        PUSH(rt_load_const_dec(qst));
Damien's avatar
Damien committed
132
133
                        break;

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

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

144
                    case MP_BC_LOAD_CONST_STRING:
145
                        DECODE_QSTR;
146
                        PUSH(rt_load_const_str(qst));
147
148
                        break;

149
                    case MP_BC_LOAD_FAST_0:
150
151
152
                        PUSH(fast0);
                        break;

153
                    case MP_BC_LOAD_FAST_1:
154
155
156
                        PUSH(fast1);
                        break;

157
                    case MP_BC_LOAD_FAST_2:
158
159
160
                        PUSH(fast2);
                        break;

161
                    case MP_BC_LOAD_FAST_N:
162
                        DECODE_UINT;
163
                        PUSH(fastn[-unum]);
164
165
                        break;

166
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
167
                        DECODE_UINT;
168
169
170
171
172
173
174
175
176
177
                        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
178
179
                        break;

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

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

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

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

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

205
                    case MP_BC_STORE_FAST_0:
206
207
208
                        fast0 = POP();
                        break;

209
                    case MP_BC_STORE_FAST_1:
210
211
212
                        fast1 = POP();
                        break;

213
                    case MP_BC_STORE_FAST_2:
214
215
216
                        fast2 = POP();
                        break;

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

222
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
223
                        DECODE_UINT;
224
225
226
227
228
229
230
231
232
233
                        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
234
235
                        break;

236
                    case MP_BC_STORE_NAME:
237
                        DECODE_QSTR;
238
                        rt_store_name(qst, POP());
239
240
                        break;

241
                    case MP_BC_STORE_GLOBAL:
242
                        DECODE_QSTR;
243
                        rt_store_global(qst, POP());
244
245
                        break;

246
                    case MP_BC_STORE_ATTR:
247
                        DECODE_QSTR;
248
                        rt_store_attr(sp[0], qst, sp[-1]);
249
                        sp -= 2;
250
251
                        break;

252
                    case MP_BC_STORE_SUBSCR:
253
254
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
255
256
                        break;

257
                    case MP_BC_DUP_TOP:
258
                        obj1 = TOP();
259
260
261
                        PUSH(obj1);
                        break;

262
                    case MP_BC_DUP_TOP_TWO:
263
264
265
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
266
267
                        break;

268
                    case MP_BC_POP_TOP:
269
                        sp -= 1;
270
271
                        break;

272
                    case MP_BC_ROT_TWO:
273
                        obj1 = sp[0];
274
275
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
276
277
                        break;

278
                    case MP_BC_ROT_THREE:
279
                        obj1 = sp[0];
280
281
282
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
283
284
                        break;

285
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
286
287
                        DECODE_SLABEL;
                        ip += unum;
288
289
                        break;

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

297
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
298
                        DECODE_SLABEL;
299
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
300
                            ip += unum;
301
302
303
                        }
                        break;

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

313
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
314
                        DECODE_SLABEL;
315
                        if (rt_is_true(TOP())) {
316
                            sp--;
Damien's avatar
Damien committed
317
318
319
320
321
                        } else {
                            ip += unum;
                        }
                        break;

322
                        /* we are trying to get away without using this opcode
323
                    case MP_BC_SETUP_LOOP:
324
                        DECODE_UINT;
325
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
326
327
328
                        break;
                        */

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

337
                    case MP_BC_END_FINALLY:
338
339
340
341
342
343
344
345
                        // 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;

346
                    case MP_BC_GET_ITER:
347
                        SET_TOP(rt_getiter(TOP()));
348
349
                        break;

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

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

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

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

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

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

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

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

412
                    case MP_BC_BUILD_MAP:
413
414
415
416
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

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

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

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

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

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

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

462
                    case MP_BC_MAKE_FUNCTION:
463
464
465
466
                        DECODE_UINT;
                        PUSH(rt_make_function_from_id(unum));
                        break;

467
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
468
469
470
471
472
                        DECODE_UINT;
                        obj1 = POP();
                        PUSH(rt_make_closure_from_id(unum, obj1));
                        break;

473
                    case MP_BC_CALL_FUNCTION:
474
                        DECODE_UINT;
475
476
477
478
                        // 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));
479
480
                        break;

481
                    case MP_BC_CALL_METHOD:
482
                        DECODE_UINT;
483
484
485
486
                        // 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));
487
488
                        break;

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

495
496
497
498
499
500
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
                        assert(unum == 1);
                        obj1 = POP();
                        nlr_jump(obj1);

501
                    case MP_BC_YIELD_VALUE:
502
503
504
                        nlr_pop();
                        *ip_in_out = ip;
                        fastn[0] = fast0;
505
506
                        fastn[-1] = fast1;
                        fastn[-2] = fast2;
507
508
                        *sp_in_out = sp;
                        return true;
509

510
                    case MP_BC_IMPORT_NAME:
511
512
                        DECODE_QSTR;
                        obj1 = POP();
513
                        SET_TOP(rt_import_name(qst, obj1, TOP()));
514
515
                        break;

516
                    case MP_BC_IMPORT_FROM:
517
                        DECODE_QSTR;
518
                        obj1 = rt_import_from(TOP(), qst);
519
520
521
                        PUSH(obj1);
                        break;

522
                    default:
Damien's avatar
Damien committed
523
                        printf("code %p, byte code 0x%02x not implemented\n", ip, op);
524
525
                        assert(0);
                        nlr_pop();
526
                        return false;
Damien's avatar
Damien committed
527
                }
528
529
530
531
532
            }

        } else {
            // exception occurred

533
534
535
            // 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);
536
537
                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);
538
539
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
540
541
                //printf("find %lu %d %d\n", bc, code_info[12], code_info[13]);
                for (const byte* ci = code_info + 12; bc >= ci[0]; ci += 2) {
542
543
544
545
546
547
                    bc -= ci[0];
                    source_line += ci[1];
                    if (ci[0] == 0 && ci[1] == 0) {
                        break;
                    }
                }
548
                mp_obj_exception_add_traceback(nlr.ret_val, source_file, source_line, block_name);
549
550
            }

551
552
553
554
555
556
557
558
559
560
561
562
563
            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
564
            if (exc_sp >= &exc_stack[0]) {
565
566
567
                // set flag to indicate that we are now handling an exception
                currently_in_except_block = 1;

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

576
            } else {
577
                // re-raise exception to higher level
578
                // TODO what to do if this is a generator??
579
580
                nlr_jump(nlr.ret_val);
            }
Damien's avatar
Damien committed
581
582
583
        }
    }
}