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
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)
21
#define DECODE_QSTR do { qst = *ip++; if (qst > 127) { qst = ((qst & 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
    n_state += 1; // XXX there is a bug somewhere which doesn't count enough state... (conwaylife and mandel have the bug)

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

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

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

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

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

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

73
74
// 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
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
    mp_obj_t fast0 = fastn[0], fast1 = fastn[-1], fast2 = fastn[-2];
84
    nlr_buf_t nlr;
Damien's avatar
Damien committed
85

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

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

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

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

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

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
116

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

289
                    case MP_BC_POP_JUMP_IF_TRUE:
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_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
297
                        DECODE_SLABEL;
298
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
299
                            ip += unum;
300
301
302
                        }
                        break;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        } else {
            // exception occurred

532
533
534
            // 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);
535
536
                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);
537
538
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
539
540
                //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) {
541
542
543
544
545
546
                    bc -= ci[0];
                    source_line += ci[1];
                    if (ci[0] == 0 && ci[1] == 0) {
                        break;
                    }
                }
547
                mp_obj_exception_set_source_info(nlr.ret_val, source_file, source_line, block_name);
548
549
            }

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

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

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