vm.c 28.1 KB
Newer Older
Damien's avatar
Damien committed
1
2
3
#include <stdio.h>
#include <assert.h>

4
#include "nlr.h"
Damien's avatar
Damien committed
5
#include "misc.h"
6
#include "mpconfig.h"
7
#include "qstr.h"
8
#include "obj.h"
Damien's avatar
Damien committed
9
#include "runtime.h"
10
#include "bc0.h"
11
#include "bc.h"
Damien's avatar
Damien committed
12

Paul Sokolovsky's avatar
Paul Sokolovsky committed
13
14
15
16
17
18
19
// 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.

20
// Exception stack unwind reasons (WHY_* in CPython-speak)
21
22
// TODO perhaps compress this to RETURN=0, JUMP>0, with number of unwinds
// left to do encoded in the JUMP number
23
24
typedef enum {
    UNWIND_RETURN = 1,
25
    UNWIND_JUMP,
26
27
} mp_unwind_reason_t;

28
29
30
31
32
33
#define DECODE_UINT { \
    unum = 0; \
    do { \
        unum = (unum << 7) + (*ip & 0x7f); \
    } while ((*ip++ & 0x80) != 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
37
38
39
40
41
#define DECODE_QSTR { \
    qst = 0; \
    do { \
        qst = (qst << 7) + (*ip & 0x7f); \
    } while ((*ip++ & 0x80) != 0); \
}
42
43
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
44
45
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
46

47
mp_vm_return_kind_t mp_execute_byte_code(const byte *code, const mp_obj_t *args, uint n_args, const mp_obj_t *args2, uint n_args2, uint n_state, mp_obj_t *ret) {
48
49
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
50
    mp_obj_t *state = &temp_state[0];
51
    if (n_state > 10) {
52
        state = m_new(mp_obj_t, n_state);
53
    }
54
55
    mp_obj_t *sp = &state[0] - 1;

56
    // init args
57
    for (uint i = 0; i < n_args; i++) {
58
        state[n_state - 1 - i] = args[i];
59
    }
60
61
62
    for (uint i = 0; i < n_args2; i++) {
        state[n_state - 1 - n_args - i] = args2[i];
    }
63

64
    const byte *ip = code;
Damien George's avatar
Damien George committed
65

66
67
68
69
    // 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
70
71
72
73
    // execute prelude to make any cells (closed over variables)
    {
        for (uint n_local = *ip++; n_local > 0; n_local--) {
            uint local_num = *ip++;
74
            if (local_num < n_args + n_args2) {
75
                state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
76
            } else {
77
                state[n_state - 1 - local_num] = mp_obj_new_cell(MP_OBJ_NULL);
Damien George's avatar
Damien George committed
78
79
80
81
            }
        }
    }

82
83
    mp_exc_stack exc_stack[4];
    mp_exc_stack *exc_sp = &exc_stack[0] - 1;
Damien George's avatar
Damien George committed
84
    // execute the byte code
85
    mp_vm_return_kind_t vm_return_kind = mp_execute_byte_code_2(code, &ip, &state[n_state - 1], &sp, exc_stack, &exc_sp, MP_OBJ_NULL);
86
87
88
89
90
91
92
93
94
95
96
97
98

    switch (vm_return_kind) {
        case MP_VM_RETURN_NORMAL:
            *ret = *sp;
            return MP_VM_RETURN_NORMAL;
        case MP_VM_RETURN_EXCEPTION:
            *ret = state[n_state - 1];
            return MP_VM_RETURN_EXCEPTION;
        case MP_VM_RETURN_YIELD: // byte-code shouldn't yield
        default:
            assert(0);
            *ret = mp_const_none;
            return MP_VM_RETURN_NORMAL;
99
100
101
    }
}

102
103
// 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
104
105
106
107
// returns:
//  MP_VM_RETURN_NORMAL, sp valid, return value in *sp
//  MP_VM_RETURN_YIELD, ip, sp valid, yielded value in *sp
//  MP_VM_RETURN_EXCEPTION, exception in fastn[0]
108
109
mp_vm_return_kind_t mp_execute_byte_code_2(const byte *code_info, const byte **ip_in_out,
                                           mp_obj_t *fastn, mp_obj_t **sp_in_out,
110
111
                                           mp_exc_stack *exc_stack, mp_exc_stack **exc_sp_in_out,
                                           volatile mp_obj_t inject_exc) {
Damien's avatar
Damien committed
112
113
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

114
    const byte *ip = *ip_in_out;
115
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
116
    machine_uint_t unum;
117
    qstr qst;
118
    mp_obj_t obj1, obj2;
119
    nlr_buf_t nlr;
Damien's avatar
Damien committed
120

121
122
    volatile bool currently_in_except_block = MP_TAGPTR_TAG(*exc_sp_in_out); // 0 or 1, to detect nested exceptions
    mp_exc_stack *volatile exc_sp = MP_TAGPTR_PTR(*exc_sp_in_out); // stack grows up, exc_sp points to top of stack
123
    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
124

125
    // outer exception handling loop
Damien's avatar
Damien committed
126
    for (;;) {
127
outer_dispatch_loop:
128
        if (nlr_push(&nlr) == 0) {
129
130
131
132
133
134
135
136
            // If we have exception to inject, now that we finish setting up
            // execution context, raise it. This works as if RAISE_VARARGS
            // bytecode was executed.
            if (inject_exc != MP_OBJ_NULL) {
                mp_obj_t t = inject_exc;
                inject_exc = MP_OBJ_NULL;
                nlr_jump(rt_make_raise_obj(t));
            }
137
138
            // loop to execute byte code
            for (;;) {
139
dispatch_loop:
140
                save_ip = ip;
141
142
                int op = *ip++;
                switch (op) {
143
144
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
145
146
                        break;

147
148
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
149
150
                        break;

151
152
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
153
                        break;
Damien George's avatar
Damien George committed
154
155
156
157

                    case MP_BC_LOAD_CONST_ELLIPSIS:
                        PUSH(mp_const_ellipsis);
                        break;
158

159
                    case MP_BC_LOAD_CONST_SMALL_INT: {
160
                        machine_int_t num = 0;
161
162
163
164
165
166
167
168
                        if ((ip[0] & 0x40) != 0) {
                            // Number is negative
                            num--;
                        }
                        do {
                            num = (num << 7) | (*ip & 0x7f);
                        } while ((*ip++ & 0x80) != 0);
                        PUSH(MP_OBJ_NEW_SMALL_INT(num));
169
                        break;
170
                    }
171

172
173
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
174
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
175
176
                        break;

177
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
178
                        DECODE_QSTR;
179
                        PUSH(rt_load_const_dec(qst));
Damien's avatar
Damien committed
180
181
                        break;

182
                    case MP_BC_LOAD_CONST_ID:
183
                        DECODE_QSTR;
184
                        PUSH(rt_load_const_str(qst)); // TODO
185
186
                        break;

187
188
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
189
                        PUSH(rt_load_const_bytes(qst));
190
191
                        break;

192
                    case MP_BC_LOAD_CONST_STRING:
193
                        DECODE_QSTR;
194
                        PUSH(rt_load_const_str(qst));
195
196
                        break;

197
                    case MP_BC_LOAD_FAST_0:
198
                        PUSH(fastn[0]);
199
200
                        break;

201
                    case MP_BC_LOAD_FAST_1:
202
                        PUSH(fastn[-1]);
203
204
                        break;

205
                    case MP_BC_LOAD_FAST_2:
206
                        PUSH(fastn[-2]);
207
208
                        break;

209
                    case MP_BC_LOAD_FAST_N:
210
                        DECODE_UINT;
211
                        PUSH(fastn[-unum]);
212
213
                        break;

214
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
215
                        DECODE_UINT;
216
                        PUSH(rt_get_cell(fastn[-unum]));
Damien's avatar
Damien committed
217
218
                        break;

219
                    case MP_BC_LOAD_NAME:
220
                        DECODE_QSTR;
221
                        PUSH(rt_load_name(qst));
222
223
                        break;

224
                    case MP_BC_LOAD_GLOBAL:
225
                        DECODE_QSTR;
226
                        PUSH(rt_load_global(qst));
227
228
                        break;

229
                    case MP_BC_LOAD_ATTR:
230
                        DECODE_QSTR;
231
                        SET_TOP(rt_load_attr(TOP(), qst));
232
233
                        break;

234
                    case MP_BC_LOAD_METHOD:
235
                        DECODE_QSTR;
236
                        rt_load_method(*sp, qst, sp);
237
                        sp += 1;
238
239
                        break;

240
                    case MP_BC_LOAD_BUILD_CLASS:
241
242
243
                        PUSH(rt_load_build_class());
                        break;

244
                    case MP_BC_STORE_FAST_0:
245
                        fastn[0] = POP();
246
247
                        break;

248
                    case MP_BC_STORE_FAST_1:
249
                        fastn[-1] = POP();
250
251
                        break;

252
                    case MP_BC_STORE_FAST_2:
253
                        fastn[-2] = POP();
254
255
                        break;

256
                    case MP_BC_STORE_FAST_N:
257
                        DECODE_UINT;
258
                        fastn[-unum] = POP();
259
260
                        break;

261
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
262
                        DECODE_UINT;
263
                        rt_set_cell(fastn[-unum], POP());
Damien's avatar
Damien committed
264
265
                        break;

266
                    case MP_BC_STORE_NAME:
267
                        DECODE_QSTR;
268
                        rt_store_name(qst, POP());
269
270
                        break;

271
                    case MP_BC_STORE_GLOBAL:
272
                        DECODE_QSTR;
273
                        rt_store_global(qst, POP());
274
275
                        break;

276
                    case MP_BC_STORE_ATTR:
277
                        DECODE_QSTR;
278
                        rt_store_attr(sp[0], qst, sp[-1]);
279
                        sp -= 2;
280
281
                        break;

282
                    case MP_BC_STORE_SUBSCR:
283
284
                        rt_store_subscr(sp[-1], sp[0], sp[-2]);
                        sp -= 3;
285
286
                        break;

287
288
289
290
291
                    case MP_BC_DELETE_NAME:
                        DECODE_QSTR;
                        rt_delete_name(qst);
                        break;

292
                    case MP_BC_DUP_TOP:
293
                        obj1 = TOP();
294
295
296
                        PUSH(obj1);
                        break;

297
                    case MP_BC_DUP_TOP_TWO:
298
299
300
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
301
302
                        break;

303
                    case MP_BC_POP_TOP:
304
                        sp -= 1;
305
306
                        break;

307
                    case MP_BC_ROT_TWO:
308
                        obj1 = sp[0];
309
310
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
311
312
                        break;

313
                    case MP_BC_ROT_THREE:
314
                        obj1 = sp[0];
315
316
317
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
318
319
                        break;

320
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
321
322
                        DECODE_SLABEL;
                        ip += unum;
323
324
                        break;

325
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
326
                        DECODE_SLABEL;
327
                        if (rt_is_true(POP())) {
Damien's avatar
Damien committed
328
                            ip += unum;
329
330
331
                        }
                        break;

332
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
333
                        DECODE_SLABEL;
334
                        if (!rt_is_true(POP())) {
Damien's avatar
Damien committed
335
                            ip += unum;
336
337
338
                        }
                        break;

339
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
340
                        DECODE_SLABEL;
341
                        if (rt_is_true(TOP())) {
Damien's avatar
Damien committed
342
343
                            ip += unum;
                        } else {
344
                            sp--;
Damien's avatar
Damien committed
345
346
347
                        }
                        break;

348
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
349
                        DECODE_SLABEL;
350
                        if (rt_is_true(TOP())) {
351
                            sp--;
Damien's avatar
Damien committed
352
353
354
355
356
                        } else {
                            ip += unum;
                        }
                        break;

357
                        /* we are trying to get away without using this opcode
358
                    case MP_BC_SETUP_LOOP:
359
                        DECODE_UINT;
360
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
361
362
363
                        break;
                        */

364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
                    case MP_BC_UNWIND_JUMP:
                        DECODE_SLABEL;
                        PUSH((void*)(ip + unum)); // push destination ip for jump
                        PUSH((void*)(machine_uint_t)(*ip)); // push number of exception handlers to unwind
unwind_jump:
                        unum = (machine_uint_t)POP(); // get number of exception handlers to unwind
                        while (unum > 0) {
                            unum -= 1;
                            assert(exc_sp >= exc_stack);
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY) {
                                // We're going to run "finally" code as a coroutine
                                // (not calling it recursively). Set up a sentinel
                                // on a stack so it can return back to us when it is
                                // done (when END_FINALLY reached).
                                PUSH((void*)unum); // push number of exception handlers left to unwind
                                PUSH(MP_OBJ_NEW_SMALL_INT(UNWIND_JUMP)); // push sentinel
                                ip = exc_sp->handler; // get exception handler byte code address
                                exc_sp--; // pop exception handler
                                goto dispatch_loop; // run the exception handler
                            }
                            exc_sp--;
                        }
                        ip = (const byte*)POP(); // pop destination ip for jump
387
388
                        break;

Damien's avatar
Damien committed
389
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
390
                    case MP_BC_SETUP_EXCEPT:
391
                    case MP_BC_SETUP_FINALLY:
Damien's avatar
Damien committed
392
                        DECODE_ULABEL; // except labels are always forward
393
394
395
                        ++exc_sp;
                        exc_sp->opcode = op;
                        exc_sp->handler = ip + unum;
396
                        exc_sp->val_sp = MP_TAGPTR_MAKE(sp, currently_in_except_block);
397
                        currently_in_except_block = 0; // in a try block now
398
399
                        break;

400
                    case MP_BC_END_FINALLY:
401
                        // not fully implemented
402
403
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
404
                        // if TOS is an integer, does something else
405
                        // else error
406
                        if (mp_obj_is_exception_instance(TOP())) {
407
408
409
410
                            nlr_jump(TOP());
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
411
412
413
414
415
416
417
                        } else if (MP_OBJ_IS_SMALL_INT(TOP())) {
                            // We finished "finally" coroutine and now dispatch back
                            // to our caller, based on TOS value
                            mp_unwind_reason_t reason = MP_OBJ_SMALL_INT_VALUE(POP());
                            switch (reason) {
                                case UNWIND_RETURN:
                                    goto unwind_return;
418
419
                                case UNWIND_JUMP:
                                    goto unwind_jump;
420
421
                            }
                            assert(0);
422
423
424
                        } else {
                            assert(0);
                        }
425
426
                        break;

427
                    case MP_BC_GET_ITER:
428
                        SET_TOP(rt_getiter(TOP()));
429
430
                        break;

431
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
432
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
433
                        obj1 = rt_iternext(TOP());
434
                        if (obj1 == mp_const_stop_iteration) {
435
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
436
                            ip += unum; // jump to after for-block
437
438
439
440
441
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
442
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
443
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
444
                        // we are exiting an exception handler, so pop the last one of the exception-stack
445
                        assert(exc_sp >= exc_stack);
446
                        currently_in_except_block = MP_TAGPTR_TAG(exc_sp->val_sp); // restore previous state
447
                        exc_sp--; // pop back to previous exception handler
448
449
                        break;

450
                    // matched against: SETUP_EXCEPT
451
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
452
                        // TODO need to work out how blocks work etc
453
                        // pops block, checks it's an exception block, and restores the stack, saving the 3 exception values to local threadstate
454
                        assert(exc_sp >= exc_stack);
455
                        assert(currently_in_except_block);
456
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
457
                        //exc_sp--; // discard ip
458
                        currently_in_except_block = MP_TAGPTR_TAG(exc_sp->val_sp); // restore previous state
459
                        exc_sp--; // pop back to previous exception handler
460
                        //sp -= 3; // pop 3 exception values
461
462
                        break;

463
464
465
466
467
468
469
470
                    case MP_BC_NOT:
                        if (TOP() == mp_const_true) {
                            SET_TOP(mp_const_false);
                        } else {
                            SET_TOP(mp_const_true);
                        }
                        break;

471
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
472
                        unum = *ip++;
473
                        SET_TOP(rt_unary_op(unum, TOP()));
Damien's avatar
Damien committed
474
475
                        break;

476
                    case MP_BC_BINARY_OP:
477
478
                        unum = *ip++;
                        obj2 = POP();
479
480
                        obj1 = TOP();
                        SET_TOP(rt_binary_op(unum, obj1, obj2));
481
482
                        break;

483
                    case MP_BC_BUILD_TUPLE:
484
                        DECODE_UINT;
485
486
                        sp -= unum - 1;
                        SET_TOP(rt_build_tuple(unum, sp));
487
488
                        break;

489
                    case MP_BC_BUILD_LIST:
490
                        DECODE_UINT;
491
492
                        sp -= unum - 1;
                        SET_TOP(rt_build_list(unum, sp));
493
494
                        break;

495
                    case MP_BC_LIST_APPEND:
496
497
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
498
499
                        rt_list_append(sp[-unum], sp[0]);
                        sp--;
500
501
                        break;

502
                    case MP_BC_BUILD_MAP:
503
504
505
506
                        DECODE_UINT;
                        PUSH(rt_build_map(unum));
                        break;

507
                    case MP_BC_STORE_MAP:
508
509
                        sp -= 2;
                        rt_store_map(sp[0], sp[2], sp[1]);
510
511
                        break;

512
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
513
                        DECODE_UINT;
514
515
516
                        // 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
517
518
                        break;

519
                    case MP_BC_BUILD_SET:
520
                        DECODE_UINT;
521
522
                        sp -= unum - 1;
                        SET_TOP(rt_build_set(unum, sp));
523
524
                        break;

525
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
526
                        DECODE_UINT;
527
528
529
                        // 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
530
531
                        break;

532
#if MICROPY_ENABLE_SLICE
533
534
535
536
537
538
539
540
541
542
543
                    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;
544
#endif
545

546
                    case MP_BC_UNPACK_SEQUENCE:
547
                        DECODE_UINT;
548
                        rt_unpack_sequence(sp[0], unum, sp);
549
                        sp += unum - 1;
550
551
                        break;

552
                    case MP_BC_MAKE_FUNCTION:
553
                        DECODE_UINT;
554
555
556
557
558
559
                        PUSH(rt_make_function_from_id(unum, MP_OBJ_NULL));
                        break;

                    case MP_BC_MAKE_FUNCTION_DEFARGS:
                        DECODE_UINT;
                        SET_TOP(rt_make_function_from_id(unum, TOP()));
560
561
                        break;

562
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
563
                        DECODE_UINT;
564
                        SET_TOP(rt_make_closure_from_id(unum, TOP()));
Damien's avatar
Damien committed
565
566
                        break;

567
                    case MP_BC_CALL_FUNCTION:
568
                        DECODE_UINT;
569
570
571
572
                        // 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));
573
574
                        break;

575
                    case MP_BC_CALL_METHOD:
576
                        DECODE_UINT;
577
578
579
580
                        // 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));
581
582
                        break;

583
                    case MP_BC_RETURN_VALUE:
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
unwind_return:
                        while (exc_sp >= exc_stack) {
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY) {
                                // We're going to run "finally" code as a coroutine
                                // (not calling it recursively). Set up a sentinel
                                // on a stack so it can return back to us when it is
                                // done (when END_FINALLY reached).
                                PUSH(MP_OBJ_NEW_SMALL_INT(UNWIND_RETURN));
                                ip = exc_sp->handler;
                                // We don't need to do anything with sp, finally is just
                                // syntactic sugar for sequential execution??
                                // sp =
                                exc_sp--;
                                goto dispatch_loop;
                            }
                            exc_sp--;
                        }
601
                        nlr_pop();
602
                        *sp_in_out = sp;
603
                        assert(exc_sp == exc_stack - 1);
604
                        return MP_VM_RETURN_NORMAL;
605

606
607
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
608
609
610
611
612
613
614
615
                        assert(unum <= 1);
                        if (unum == 0) {
                            // This assumes that nlr.ret_val holds last raised
                            // exception and is not overwritten since then.
                            obj1 = nlr.ret_val;
                        } else {
                            obj1 = POP();
                        }
616
                        nlr_jump(rt_make_raise_obj(obj1));
617

618
                    case MP_BC_YIELD_VALUE:
619
620
621
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
622
                        *exc_sp_in_out = MP_TAGPTR_MAKE(exc_sp, currently_in_except_block);
623
                        return MP_VM_RETURN_YIELD;
624

625
                    case MP_BC_IMPORT_NAME:
626
627
                        DECODE_QSTR;
                        obj1 = POP();
628
                        SET_TOP(rt_import_name(qst, obj1, TOP()));
629
630
                        break;

631
                    case MP_BC_IMPORT_FROM:
632
                        DECODE_QSTR;
633
                        obj1 = rt_import_from(TOP(), qst);
634
635
636
                        PUSH(obj1);
                        break;

637
                    case MP_BC_IMPORT_STAR:
638
                        rt_import_all(POP());
639
640
                        break;

641
                    default:
Damien's avatar
Damien committed
642
                        printf("code %p, byte code 0x%02x not implemented\n", ip, op);
643
644
                        assert(0);
                        nlr_pop();
645
                        return MP_VM_RETURN_NORMAL;
Damien's avatar
Damien committed
646
                }
647
648
649
650
651
            }

        } else {
            // exception occurred

652
653
654
655
656
657
658
659
660
            // check if it's a StopIteration within a for block
            if (*save_ip == MP_BC_FOR_ITER && mp_obj_is_subclass_fast(mp_obj_get_type(nlr.ret_val), &mp_type_StopIteration)) {
                ip = save_ip + 1;
                DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
                --sp; // pop the exhausted iterator
                ip += unum; // jump to after for-block
                goto outer_dispatch_loop; // continue with dispatch loop
            }

661
            // set file and line number that the exception occurred at
662
663
            // TODO: don't set traceback for exceptions re-raised by END_FINALLY.
            // But consider how to handle nested exceptions.
664
            if (mp_obj_is_exception_instance(nlr.ret_val)) {
665
                machine_uint_t code_info_size = code_info[0] | (code_info[1] << 8) | (code_info[2] << 16) | (code_info[3] << 24);
666
667
                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);
668
669
                machine_uint_t source_line = 1;
                machine_uint_t bc = save_ip - code_info - code_info_size;
670
                //printf("find %lu %d %d\n", bc, code_info[12], code_info[13]);
671
672
673
                for (const byte* ci = code_info + 12; *ci && bc >= ((*ci) & 31); ci++) {
                    bc -= *ci & 31;
                    source_line += *ci >> 5;
674
                }
675
                mp_obj_exception_add_traceback(nlr.ret_val, source_file, source_line, block_name);
676
677
            }

678
679
680
            while (currently_in_except_block) {
                // nested exception

681
                assert(exc_sp >= exc_stack);
682
683
684
685
686

                // 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
687
                currently_in_except_block = MP_TAGPTR_TAG(exc_sp->val_sp); // restore previous state
688
                exc_sp--; // pop back to previous exception handler
689
690
            }

691
            if (exc_sp >= exc_stack) {
692
693
694
                // set flag to indicate that we are now handling an exception
                currently_in_except_block = 1;

695
                // catch exception and pass to byte code
696
                sp = MP_TAGPTR_PTR(exc_sp->val_sp);
697
                ip = exc_sp->handler;
Damien's avatar
Damien committed
698
                // push(traceback, exc-val, exc-type)
699
                PUSH(mp_const_none);
Damien's avatar
Damien committed
700
                PUSH(nlr.ret_val);
701
                PUSH(nlr.ret_val); // TODO should be type(nlr.ret_val), I think...
702

703
            } else {
704
705
706
707
                // propagate exception to higher level
                // TODO what to do about ip and sp? they don't really make sense at this point
                fastn[0] = nlr.ret_val; // must put exception here because sp is invalid
                return MP_VM_RETURN_EXCEPTION;
708
            }
Damien's avatar
Damien committed
709
710
711
        }
    }
}