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

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

16
17
#define DETECT_VM_STACK_OVERFLOW (0)

Paul Sokolovsky's avatar
Paul Sokolovsky committed
18
19
20
21
22
23
24
// 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.

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

33
#define DECODE_UINT do { \
34
35
36
37
    unum = 0; \
    do { \
        unum = (unum << 7) + (*ip & 0x7f); \
    } while ((*ip++ & 0x80) != 0); \
38
} while (0)
Damien's avatar
Damien committed
39
40
#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)
41
#define DECODE_QSTR do { \
42
43
44
45
    qst = 0; \
    do { \
        qst = (qst << 7) + (*ip & 0x7f); \
    } while ((*ip++ & 0x80) != 0); \
46
47
48
49
50
51
} while (0)
#define DECODE_PTR do { \
    ip = (byte*)(((machine_uint_t)ip + sizeof(machine_uint_t) - 1) & (~(sizeof(machine_uint_t) - 1))); /* align ip */ \
    unum = *(machine_uint_t*)ip; \
    ip += sizeof(machine_uint_t); \
} while (0)
52
53
#define PUSH(val) *++sp = (val)
#define POP() (*sp--)
54
55
#define TOP() (*sp)
#define SET_TOP(val) *sp = (val)
Damien's avatar
Damien committed
56

57
#define PUSH_EXC_BLOCK() \
58
59
60
61
62
    DECODE_ULABEL; /* except labels are always forward */ \
    ++exc_sp; \
    exc_sp->opcode = op; \
    exc_sp->handler = ip + unum; \
    exc_sp->val_sp = MP_TAGPTR_MAKE(sp, currently_in_except_block); \
Damien George's avatar
Damien George committed
63
    exc_sp->prev_exc = MP_OBJ_NULL; \
64
65
    currently_in_except_block = 0; /* in a try block now */

66
67
68
69
#define POP_EXC_BLOCK() \
    currently_in_except_block = MP_TAGPTR_TAG(exc_sp->val_sp); /* restore previous state */ \
    exc_sp--; /* pop back to previous exception handler */

70
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, mp_obj_t *ret) {
71
72
73
74
75
76
    const byte *ip = code;

    // get code info size, and skip line number table
    machine_uint_t code_info_size = ip[0] | (ip[1] << 8) | (ip[2] << 16) | (ip[3] << 24);
    ip += code_info_size;

77
78
79
80
    // bytecode prelude: state size and exception stack size; 16 bit uints
    machine_uint_t n_state = ip[0] | (ip[1] << 8);
    machine_uint_t n_exc_stack = ip[2] | (ip[3] << 8);
    ip += 4;
81

82
83
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
84
    mp_obj_t *state = &temp_state[0];
85
#if DETECT_VM_STACK_OVERFLOW
86
87
    n_state += 1;
#endif
88
    if (n_state > 10) {
89
        state = m_new(mp_obj_t, n_state);
90
    }
91
92
    mp_obj_t *sp = &state[0] - 1;

93
    // allocate state for exceptions
94
95
    mp_exc_stack_t exc_state[4];
    mp_exc_stack_t *exc_stack = &exc_state[0];
96
    if (n_exc_stack > 4) {
97
        exc_stack = m_new(mp_exc_stack_t, n_exc_stack);
98
    }
99
    mp_exc_stack_t *exc_sp = &exc_stack[0] - 1;
100

101
    // init args
102
    for (uint i = 0; i < n_args; i++) {
103
        state[n_state - 1 - i] = args[i];
104
    }
105
106
107
    for (uint i = 0; i < n_args2; i++) {
        state[n_state - 1 - n_args - i] = args2[i];
    }
108

109
110
111
112
113
    // set rest of state to MP_OBJ_NULL
    for (uint i = 0; i < n_state - n_args - n_args2; i++) {
        state[i] = MP_OBJ_NULL;
    }

114
115
116
    // bytecode prelude: initialise closed over variables
    for (uint n_local = *ip++; n_local > 0; n_local--) {
        uint local_num = *ip++;
117
        state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
118
119
120
    }

    // execute the byte code
121
    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);
122

123
#if DETECT_VM_STACK_OVERFLOW
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
    // We can't check the case when an exception is returned in state[n_state - 1]
    // and there are no arguments, because in this case our detection slot may have
    // been overwritten by the returned exception (which is allowed).
    if (!(vm_return_kind == MP_VM_RETURN_EXCEPTION && n_args == 0 && n_args2 == 0)) {
        // Just check to see that we have at least 1 null object left in the state.
        bool overflow = true;
        for (uint i = 0; i < n_state - n_args - n_args2; i++) {
            if (state[i] == MP_OBJ_NULL) {
                overflow = false;
                break;
            }
        }
        if (overflow) {
            printf("VM stack overflow state=%p n_state+1=%u\n", state, n_state);
            assert(0);
        }
140
141
142
    }
#endif

143
144
145
146
147
148
149
150
151
152
153
154
    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;
155
156
157
    }
}

158
159
// 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
160
161
162
163
// 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]
164
165
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,
166
                                           mp_exc_stack_t *exc_stack, mp_exc_stack_t **exc_sp_in_out,
167
                                           volatile mp_obj_t inject_exc) {
Damien's avatar
Damien committed
168
169
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

170
    const byte *ip = *ip_in_out;
171
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
172
    machine_uint_t unum;
173
    qstr qst;
174
    mp_obj_t obj1, obj2;
175
    nlr_buf_t nlr;
Damien's avatar
Damien committed
176

177
    volatile bool currently_in_except_block = MP_TAGPTR_TAG(*exc_sp_in_out); // 0 or 1, to detect nested exceptions
178
    mp_exc_stack_t *volatile exc_sp = MP_TAGPTR_PTR(*exc_sp_in_out); // stack grows up, exc_sp points to top of stack
179
    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
180

181
    // outer exception handling loop
Damien's avatar
Damien committed
182
    for (;;) {
183
outer_dispatch_loop:
184
        if (nlr_push(&nlr) == 0) {
185
186
187
            // 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.
188
189
190
            // Injecting exc into yield from generator is a special case,
            // handled by MP_BC_YIELD_FROM itself
            if (inject_exc != MP_OBJ_NULL && *ip != MP_BC_YIELD_FROM) {
191
192
                mp_obj_t t = inject_exc;
                inject_exc = MP_OBJ_NULL;
193
                nlr_raise(mp_make_raise_obj(t));
194
            }
195
196
            // loop to execute byte code
            for (;;) {
197
dispatch_loop:
198
                save_ip = ip;
199
                int op = *ip++;
200
                //printf("ip=%p sp=%p op=%u\n", save_ip, sp, op);
201
                switch (op) {
202
203
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
204
205
                        break;

206
207
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
208
209
                        break;

210
211
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
212
                        break;
Damien George's avatar
Damien George committed
213
214

                    case MP_BC_LOAD_CONST_ELLIPSIS:
215
                        PUSH((mp_obj_t)&mp_const_ellipsis_obj);
Damien George's avatar
Damien George committed
216
                        break;
217

218
                    case MP_BC_LOAD_CONST_SMALL_INT: {
219
                        machine_int_t num = 0;
220
221
222
223
224
225
226
227
                        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));
228
                        break;
229
                    }
230

231
232
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
233
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
234
235
                        break;

236
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
237
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
238
                        PUSH(mp_load_const_dec(qst));
Damien's avatar
Damien committed
239
240
                        break;

241
                    case MP_BC_LOAD_CONST_ID:
242
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
243
                        PUSH(mp_load_const_str(qst)); // TODO
244
245
                        break;

246
247
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
248
                        PUSH(mp_load_const_bytes(qst));
249
250
                        break;

251
                    case MP_BC_LOAD_CONST_STRING:
252
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
253
                        PUSH(mp_load_const_str(qst));
254
255
                        break;

256
257
258
259
                    case MP_BC_LOAD_NULL:
                        PUSH(MP_OBJ_NULL);
                        break;

260
                    case MP_BC_LOAD_FAST_0:
261
262
                        obj1 = fastn[0];
                        goto load_check;
263

264
                    case MP_BC_LOAD_FAST_1:
265
266
                        obj1 = fastn[-1];
                        goto load_check;
267

268
                    case MP_BC_LOAD_FAST_2:
269
270
                        obj1 = fastn[-2];
                        goto load_check;
271

272
                    case MP_BC_LOAD_FAST_N:
273
274
                        DECODE_UINT;
                        obj1 = fastn[-unum];
275
                        load_check:
276
277
278
279
280
281
282
                        if (obj1 == MP_OBJ_NULL) {
                            local_name_error:
                            nlr_raise(mp_obj_new_exception_msg(&mp_type_NameError, "local variable referenced before assignment"));
                        }
                        PUSH(obj1);
                        break;

283
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
284
                        DECODE_UINT;
285
                        obj1 = mp_obj_cell_get(fastn[-unum]);
286
                        goto load_check;
Damien's avatar
Damien committed
287

288
                    case MP_BC_LOAD_NAME:
289
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
290
                        PUSH(mp_load_name(qst));
291
292
                        break;

293
                    case MP_BC_LOAD_GLOBAL:
294
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
295
                        PUSH(mp_load_global(qst));
296
297
                        break;

298
                    case MP_BC_LOAD_ATTR:
299
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
300
                        SET_TOP(mp_load_attr(TOP(), qst));
301
302
                        break;

303
                    case MP_BC_LOAD_METHOD:
304
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
305
                        mp_load_method(*sp, qst, sp);
306
                        sp += 1;
307
308
                        break;

309
                    case MP_BC_LOAD_BUILD_CLASS:
Damien George's avatar
Damien George committed
310
                        PUSH(mp_load_build_class());
311
312
                        break;

313
                    case MP_BC_STORE_FAST_0:
314
                        fastn[0] = POP();
315
316
                        break;

317
                    case MP_BC_STORE_FAST_1:
318
                        fastn[-1] = POP();
319
320
                        break;

321
                    case MP_BC_STORE_FAST_2:
322
                        fastn[-2] = POP();
323
324
                        break;

325
                    case MP_BC_STORE_FAST_N:
326
                        DECODE_UINT;
327
                        fastn[-unum] = POP();
328
329
                        break;

330
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
331
                        DECODE_UINT;
332
                        mp_obj_cell_set(fastn[-unum], POP());
Damien's avatar
Damien committed
333
334
                        break;

335
                    case MP_BC_STORE_NAME:
336
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
337
                        mp_store_name(qst, POP());
338
339
                        break;

340
                    case MP_BC_STORE_GLOBAL:
341
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
342
                        mp_store_global(qst, POP());
343
344
                        break;

345
                    case MP_BC_STORE_ATTR:
346
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
347
                        mp_store_attr(sp[0], qst, sp[-1]);
348
                        sp -= 2;
349
350
                        break;

351
                    case MP_BC_STORE_SUBSCR:
Damien George's avatar
Damien George committed
352
                        mp_store_subscr(sp[-1], sp[0], sp[-2]);
353
                        sp -= 3;
354
355
                        break;

356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
                    case MP_BC_DELETE_FAST:
                        DECODE_UINT;
                        if (fastn[-unum] == MP_OBJ_NULL) {
                            goto local_name_error;
                        }
                        fastn[-unum] = MP_OBJ_NULL;
                        break;

                    case MP_BC_DELETE_DEREF:
                        DECODE_UINT;
                        if (mp_obj_cell_get(fastn[-unum]) == MP_OBJ_NULL) {
                            goto local_name_error;
                        }
                        mp_obj_cell_set(fastn[-unum], MP_OBJ_NULL);
                        break;

372
373
                    case MP_BC_DELETE_NAME:
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
374
                        mp_delete_name(qst);
375
376
                        break;

377
378
379
380
381
                    case MP_BC_DELETE_GLOBAL:
                        DECODE_QSTR;
                        mp_delete_global(qst);
                        break;

382
                    case MP_BC_DUP_TOP:
383
                        obj1 = TOP();
384
385
386
                        PUSH(obj1);
                        break;

387
                    case MP_BC_DUP_TOP_TWO:
388
389
390
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
391
392
                        break;

393
                    case MP_BC_POP_TOP:
394
                        sp -= 1;
395
396
                        break;

397
                    case MP_BC_ROT_TWO:
398
                        obj1 = sp[0];
399
400
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
401
402
                        break;

403
                    case MP_BC_ROT_THREE:
404
                        obj1 = sp[0];
405
406
407
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
408
409
                        break;

410
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
411
412
                        DECODE_SLABEL;
                        ip += unum;
413
414
                        break;

415
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
416
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
417
                        if (mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
418
                            ip += unum;
419
420
421
                        }
                        break;

422
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
423
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
424
                        if (!mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
425
                            ip += unum;
426
427
428
                        }
                        break;

429
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
430
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
431
                        if (mp_obj_is_true(TOP())) {
Damien's avatar
Damien committed
432
433
                            ip += unum;
                        } else {
434
                            sp--;
Damien's avatar
Damien committed
435
436
437
                        }
                        break;

438
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
439
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
440
                        if (mp_obj_is_true(TOP())) {
441
                            sp--;
Damien's avatar
Damien committed
442
443
444
445
446
                        } else {
                            ip += unum;
                        }
                        break;

447
                        /* we are trying to get away without using this opcode
448
                    case MP_BC_SETUP_LOOP:
449
                        DECODE_UINT;
450
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
451
452
453
                        break;
                        */

454
                    case MP_BC_SETUP_WITH:
455
                        obj1 = TOP();
Damien George's avatar
Damien George committed
456
457
458
                        SET_TOP(mp_load_attr(obj1, MP_QSTR___exit__));
                        mp_load_method(obj1, MP_QSTR___enter__, sp + 1);
                        obj2 = mp_call_method_n_kw(0, 0, sp + 1);
459
                        PUSH_EXC_BLOCK();
460
461
462
463
                        PUSH(obj2);
                        break;

                    case MP_BC_WITH_CLEANUP: {
464
465
466
467
                        // Arriving here, there's "exception control block" on top of stack,
                        // and __exit__ bound method underneath it. Bytecode calls __exit__,
                        // and "deletes" it off stack, shifting "exception control block"
                        // to its place.
468
469
470
471
472
                        static const mp_obj_t no_exc[] = {mp_const_none, mp_const_none, mp_const_none};
                        if (TOP() == mp_const_none) {
                            sp--;
                            obj1 = TOP();
                            SET_TOP(mp_const_none);
Damien George's avatar
Damien George committed
473
                            obj2 = mp_call_function_n_kw(obj1, 3, 0, no_exc);
474
475
476
477
478
                        } else if (MP_OBJ_IS_SMALL_INT(TOP())) {
                            mp_obj_t cause = POP();
                            switch (MP_OBJ_SMALL_INT_VALUE(cause)) {
                                case UNWIND_RETURN: {
                                    mp_obj_t retval = POP();
Damien George's avatar
Damien George committed
479
                                    obj2 = mp_call_function_n_kw(TOP(), 3, 0, no_exc);
480
481
482
483
484
                                    SET_TOP(retval);
                                    PUSH(cause);
                                    break;
                                }
                                case UNWIND_JUMP: {
Damien George's avatar
Damien George committed
485
                                    obj2 = mp_call_function_n_kw(sp[-2], 3, 0, no_exc);
486
487
488
489
490
491
492
493
494
495
496
                                    // Pop __exit__ boundmethod at sp[-2]
                                    sp[-2] = sp[-1];
                                    sp[-1] = sp[0];
                                    SET_TOP(cause);
                                    break;
                                }
                                default:
                                    assert(0);
                            }
                        } else if (mp_obj_is_exception_type(TOP())) {
                            mp_obj_t args[3] = {sp[0], sp[-1], sp[-2]};
Damien George's avatar
Damien George committed
497
                            obj2 = mp_call_function_n_kw(sp[-3], 3, 0, args);
498
499
500
501
502
503
                            // Pop __exit__ boundmethod at sp[-3]
                            // TODO: Once semantics is proven, optimize for case when obj2 == True
                            sp[-3] = sp[-2];
                            sp[-2] = sp[-1];
                            sp[-1] = sp[0];
                            sp--;
Damien George's avatar
Damien George committed
504
                            if (mp_obj_is_true(obj2)) {
505
506
507
508
                                // This is what CPython does
                                //PUSH(MP_OBJ_NEW_SMALL_INT(UNWIND_SILENCED));
                                // But what we need to do is - pop exception from value stack...
                                sp -= 3;
509
510
                                // ... pop "with" exception handler, and signal END_FINALLY
                                // to just execute finally handler normally (by pushing None
511
512
513
                                // on value stack)
                                assert(exc_sp >= exc_stack);
                                assert(exc_sp->opcode == MP_BC_SETUP_WITH);
514
                                POP_EXC_BLOCK();
515
516
517
518
519
520
521
522
                                PUSH(mp_const_none);
                            }
                        } else {
                            assert(0);
                        }
                        break;
                    }

523
524
525
526
527
528
529
530
531
                    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);
532
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
533
534
535
536
537
538
539
540
541
542
543
544
545
                                // 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
546
547
                        break;

Damien's avatar
Damien committed
548
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
549
                    case MP_BC_SETUP_EXCEPT:
550
                    case MP_BC_SETUP_FINALLY:
551
                        PUSH_EXC_BLOCK();
552
553
                        break;

554
                    case MP_BC_END_FINALLY:
555
                        // not fully implemented
556
557
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
558
                        // if TOS is an integer, does something else
559
                        // else error
560
                        if (mp_obj_is_exception_type(TOP())) {
561
                            nlr_raise(sp[-1]);
562
563
564
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
565
566
567
568
569
570
571
                        } 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;
572
573
                                case UNWIND_JUMP:
                                    goto unwind_jump;
574
575
                            }
                            assert(0);
576
577
578
                        } else {
                            assert(0);
                        }
579
580
                        break;

581
                    case MP_BC_GET_ITER:
Damien George's avatar
Damien George committed
582
                        SET_TOP(mp_getiter(TOP()));
583
584
                        break;

585
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
586
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
Damien George's avatar
Damien George committed
587
                        obj1 = mp_iternext_allow_raise(TOP());
588
                        if (obj1 == MP_OBJ_NULL) {
589
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
590
                            ip += unum; // jump to after for-block
591
592
593
594
595
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
596
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
597
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
598
                        // we are exiting an exception handler, so pop the last one of the exception-stack
599
                        assert(exc_sp >= exc_stack);
600
                        POP_EXC_BLOCK();
601
602
                        break;

603
                    // matched against: SETUP_EXCEPT
604
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
605
                        // TODO need to work out how blocks work etc
606
                        // pops block, checks it's an exception block, and restores the stack, saving the 3 exception values to local threadstate
607
                        assert(exc_sp >= exc_stack);
608
                        assert(currently_in_except_block);
609
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
610
                        //exc_sp--; // discard ip
611
                        POP_EXC_BLOCK();
612
                        //sp -= 3; // pop 3 exception values
613
614
                        break;

615
616
617
618
619
620
621
622
                    case MP_BC_NOT:
                        if (TOP() == mp_const_true) {
                            SET_TOP(mp_const_false);
                        } else {
                            SET_TOP(mp_const_true);
                        }
                        break;

623
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
624
                        unum = *ip++;
Damien George's avatar
Damien George committed
625
                        SET_TOP(mp_unary_op(unum, TOP()));
Damien's avatar
Damien committed
626
627
                        break;

628
                    case MP_BC_BINARY_OP:
629
630
                        unum = *ip++;
                        obj2 = POP();
631
                        obj1 = TOP();
Damien George's avatar
Damien George committed
632
                        SET_TOP(mp_binary_op(unum, obj1, obj2));
633
634
                        break;

635
                    case MP_BC_BUILD_TUPLE:
636
                        DECODE_UINT;
637
                        sp -= unum - 1;
638
                        SET_TOP(mp_obj_new_tuple(unum, sp));
639
640
                        break;

641
                    case MP_BC_BUILD_LIST:
642
                        DECODE_UINT;
643
                        sp -= unum - 1;
644
                        SET_TOP(mp_obj_new_list(unum, sp));
645
646
                        break;

647
                    case MP_BC_LIST_APPEND:
648
649
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
650
                        mp_obj_list_append(sp[-unum], sp[0]);
651
                        sp--;
652
653
                        break;

654
                    case MP_BC_BUILD_MAP:
655
                        DECODE_UINT;
656
                        PUSH(mp_obj_new_dict(unum));
657
658
                        break;

659
                    case MP_BC_STORE_MAP:
660
                        sp -= 2;
661
                        mp_obj_dict_store(sp[0], sp[2], sp[1]);
662
663
                        break;

664
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
665
                        DECODE_UINT;
666
                        // I think it's guaranteed by the compiler that sp[-unum - 1] is a map
667
                        mp_obj_dict_store(sp[-unum - 1], sp[0], sp[-1]);
668
                        sp -= 2;
Damien's avatar
Damien committed
669
670
                        break;

671
                    case MP_BC_BUILD_SET:
672
                        DECODE_UINT;
673
                        sp -= unum - 1;
674
                        SET_TOP(mp_obj_new_set(unum, sp));
675
676
                        break;

677
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
678
                        DECODE_UINT;
679
                        // I think it's guaranteed by the compiler that sp[-unum] is a set
680
                        mp_obj_set_store(sp[-unum], sp[0]);
681
                        sp--;
Damien's avatar
Damien committed
682
683
                        break;

684
#if MICROPY_ENABLE_SLICE
685
686
687
688
689
690
691
                    case MP_BC_BUILD_SLICE:
                        DECODE_UINT;
                        if (unum == 2) {
                            obj2 = POP();
                            obj1 = TOP();
                            SET_TOP(mp_obj_new_slice(obj1, obj2, NULL));
                        } else {
692
693
694
695
                            obj1 = mp_obj_new_exception_msg(&mp_type_NotImplementedError, "3-argument slice is not supported");
                            nlr_pop();
                            fastn[0] = obj1;
                            return MP_VM_RETURN_EXCEPTION;
696
697
                        }
                        break;
698
#endif
699

700
                    case MP_BC_UNPACK_SEQUENCE:
701
                        DECODE_UINT;
Damien George's avatar
Damien George committed
702
                        mp_unpack_sequence(sp[0], unum, sp);
703
                        sp += unum - 1;
704
705
                        break;

706
707
708
709
710
711
                    case MP_BC_UNPACK_EX:
                        DECODE_UINT;
                        mp_unpack_ex(sp[0], unum, sp);
                        sp += (unum & 0xff) + ((unum >> 8) & 0xff);
                        break;

712
                    case MP_BC_MAKE_FUNCTION:
713
714
                        DECODE_PTR;
                        PUSH(mp_make_function_from_raw_code((mp_raw_code_t*)unum, MP_OBJ_NULL, MP_OBJ_NULL));
715
716
717
                        break;

                    case MP_BC_MAKE_FUNCTION_DEFARGS:
718
                        DECODE_PTR;
719
                        // Stack layout: def_tuple def_dict <- TOS
720
                        obj1 = POP();
721
                        SET_TOP(mp_make_function_from_raw_code((mp_raw_code_t*)unum, TOP(), obj1));
722
723
                        break;

724
                    case MP_BC_MAKE_CLOSURE:
725
                        DECODE_PTR;
726
                        // Stack layout: closure_tuple <- TOS
727
                        SET_TOP(mp_make_closure_from_raw_code((mp_raw_code_t*)unum, TOP(), MP_OBJ_NULL, MP_OBJ_NULL));
728
729
730
                        break;

                    case MP_BC_MAKE_CLOSURE_DEFARGS:
731
                        DECODE_PTR;
732
                        // Stack layout: def_tuple def_dict closure_tuple <- TOS
733
                        obj1 = POP();
734
                        obj2 = POP();
735
                        SET_TOP(mp_make_closure_from_raw_code((mp_raw_code_t*)unum, obj1, TOP(), obj2));
Damien's avatar
Damien committed
736
737
                        break;

738
                    case MP_BC_CALL_FUNCTION:
739
                        DECODE_UINT;
740
741
742
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe);
Damien George's avatar
Damien George committed
743
                        SET_TOP(mp_call_function_n_kw(*sp, unum & 0xff, (unum >> 8) & 0xff, sp + 1));
744
745
                        break;

746
747
748
749
750
751
                    case MP_BC_CALL_FUNCTION_VAR_KW:
                        DECODE_UINT;
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        // We have folowing stack layout here:
                        // fun arg0 arg1 ... kw0 val0 kw1 val1 ... seq dict <- TOS
752
753
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 2;
                        SET_TOP(mp_call_method_n_kw_var(false, unum, sp));
754
755
                        break;

756
                    case MP_BC_CALL_METHOD:
757
                        DECODE_UINT;
758
759
760
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 1;
Damien George's avatar
Damien George committed
761
                        SET_TOP(mp_call_method_n_kw(unum & 0xff, (unum >> 8) & 0xff, sp));
762
                        break;
763
764
765
766
767
768
769

                    case MP_BC_CALL_METHOD_VAR_KW:
                        DECODE_UINT;
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        // We have folowing stack layout here:
                        // fun self arg0 arg1 ... kw0 val0 kw1 val1 ... seq dict <- TOS
770
771
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 3;
                        SET_TOP(mp_call_method_n_kw_var(true, unum, sp));
772
                        break;
773

774
                    case MP_BC_RETURN_VALUE:
775
776
unwind_return:
                        while (exc_sp >= exc_stack) {
777
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
778
779
780
781
782
783
784
785
786
787
788
789
790
791
                                // 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--;
                        }
792
                        nlr_pop();
793
                        *sp_in_out = sp;
794
                        assert(exc_sp == exc_stack - 1);
795
                        return MP_VM_RETURN_NORMAL;
796

797
798
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
799
800
                        assert(unum <= 1);
                        if (unum == 0) {
Damien George's avatar
Damien George committed
801
802
                            // search for the inner-most previous exception, to reraise it
                            obj1 = MP_OBJ_NULL;
803
                            for (mp_exc_stack_t *e = exc_sp; e >= exc_stack; e--) {
Damien George's avatar
Damien George committed
804
805
806
807
808
809
                                if (e->prev_exc != MP_OBJ_NULL) {
                                    obj1 = e->prev_exc;
                                    break;
                                }
                            }
                            if (obj1 == MP_OBJ_NULL) {
810
                                nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "No active exception to reraise"));
811
                            }
812
813
814
                        } else {
                            obj1 = POP();
                        }
815
                        nlr_raise(mp_make_raise_obj(obj1));
816

817
                    case MP_BC_YIELD_VALUE:
818
yield:
819
820
821
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
822
                        *exc_sp_in_out = MP_TAGPTR_MAKE(exc_sp, currently_in_except_block);
823
                        return MP_VM_RETURN_YIELD;
824

825
                    case MP_BC_YIELD_FROM: {
826
827
//#define EXC_MATCH(exc, type) MP_OBJ_IS_TYPE(exc, type)
#define EXC_MATCH(exc, type) mp_obj_exception_match(exc, type)
828
#define GENERATOR_EXIT_IF_NEEDED(t) if (t != MP_OBJ_NULL && EXC_MATCH(t, &mp_type_GeneratorExit)) { nlr_raise(t); }
829
830
                        mp_vm_return_kind_t ret_kind;
                        obj1 = POP();
831
                        mp_obj_t t_exc = MP_OBJ_NULL;
832
                        if (inject_exc != MP_OBJ_NULL) {
833
                            t_exc = inject_exc;
834
                            inject_exc = MP_OBJ_NULL;