vm.c 37.8 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"
Damien's avatar
Damien committed
10
#include "runtime.h"
11
#include "bc0.h"
12
#include "bc.h"
13
#include "objgenerator.h"
Damien's avatar
Damien committed
14

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

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

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

49
#define PUSH_EXC_BLOCK() \
50
51
52
53
54
    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
55
    exc_sp->prev_exc = MP_OBJ_NULL; \
56
57
    currently_in_except_block = 0; /* in a try block now */

58
59
60
61
#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 */

62
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) {
63
64
65
66
67
68
    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;

69
70
71
72
    // 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;
73

74
75
    // allocate state for locals and stack
    mp_obj_t temp_state[10];
76
    mp_obj_t *state = &temp_state[0];
77
    if (n_state > 10) {
78
        state = m_new(mp_obj_t, n_state);
79
    }
80
81
    mp_obj_t *sp = &state[0] - 1;

82
    // allocate state for exceptions
83
84
    mp_exc_stack_t exc_state[4];
    mp_exc_stack_t *exc_stack = &exc_state[0];
85
    if (n_exc_stack > 4) {
86
        exc_stack = m_new(mp_exc_stack_t, n_exc_stack);
87
    }
88
    mp_exc_stack_t *exc_sp = &exc_stack[0] - 1;
89

90
    // init args
91
    for (uint i = 0; i < n_args; i++) {
92
        state[n_state - 1 - i] = args[i];
93
    }
94
95
96
    for (uint i = 0; i < n_args2; i++) {
        state[n_state - 1 - n_args - i] = args2[i];
    }
97

98
99
100
101
102
103
104
    // bytecode prelude: initialise closed over variables
    for (uint n_local = *ip++; n_local > 0; n_local--) {
        uint local_num = *ip++;
        if (local_num < n_args + n_args2) {
            state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
        } else {
            state[n_state - 1 - local_num] = mp_obj_new_cell(MP_OBJ_NULL);
Damien George's avatar
Damien George committed
105
106
107
108
        }
    }

    // execute the byte code
109
    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);
110
111
112
113
114
115
116
117
118
119
120
121
122

    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;
123
124
125
    }
}

126
127
// 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
128
129
130
131
// 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]
132
133
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,
134
                                           mp_exc_stack_t *exc_stack, mp_exc_stack_t **exc_sp_in_out,
135
                                           volatile mp_obj_t inject_exc) {
Damien's avatar
Damien committed
136
137
    // careful: be sure to declare volatile any variables read in the exception handler (written is ok, I think)

138
    const byte *ip = *ip_in_out;
139
    mp_obj_t *sp = *sp_in_out;
Damien's avatar
Damien committed
140
    machine_uint_t unum;
141
    qstr qst;
142
    mp_obj_t obj1, obj2;
143
    nlr_buf_t nlr;
Damien's avatar
Damien committed
144

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

149
    // outer exception handling loop
Damien's avatar
Damien committed
150
    for (;;) {
151
outer_dispatch_loop:
152
        if (nlr_push(&nlr) == 0) {
153
154
155
            // 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.
156
157
158
            // 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) {
159
160
                mp_obj_t t = inject_exc;
                inject_exc = MP_OBJ_NULL;
161
                nlr_raise(mp_make_raise_obj(t));
162
            }
163
164
            // loop to execute byte code
            for (;;) {
165
dispatch_loop:
166
                save_ip = ip;
167
168
                int op = *ip++;
                switch (op) {
169
170
                    case MP_BC_LOAD_CONST_FALSE:
                        PUSH(mp_const_false);
171
172
                        break;

173
174
                    case MP_BC_LOAD_CONST_NONE:
                        PUSH(mp_const_none);
175
176
                        break;

177
178
                    case MP_BC_LOAD_CONST_TRUE:
                        PUSH(mp_const_true);
179
                        break;
Damien George's avatar
Damien George committed
180
181

                    case MP_BC_LOAD_CONST_ELLIPSIS:
182
                        PUSH((mp_obj_t)&mp_const_ellipsis_obj);
Damien George's avatar
Damien George committed
183
                        break;
184

185
                    case MP_BC_LOAD_CONST_SMALL_INT: {
186
                        machine_int_t num = 0;
187
188
189
190
191
192
193
194
                        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));
195
                        break;
196
                    }
197

198
199
                    case MP_BC_LOAD_CONST_INT:
                        DECODE_QSTR;
200
                        PUSH(mp_obj_new_int_from_long_str(qstr_str(qst)));
201
202
                        break;

203
                    case MP_BC_LOAD_CONST_DEC:
Damien's avatar
Damien committed
204
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
205
                        PUSH(mp_load_const_dec(qst));
Damien's avatar
Damien committed
206
207
                        break;

208
                    case MP_BC_LOAD_CONST_ID:
209
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
210
                        PUSH(mp_load_const_str(qst)); // TODO
211
212
                        break;

213
214
                    case MP_BC_LOAD_CONST_BYTES:
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
215
                        PUSH(mp_load_const_bytes(qst));
216
217
                        break;

218
                    case MP_BC_LOAD_CONST_STRING:
219
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
220
                        PUSH(mp_load_const_str(qst));
221
222
                        break;

223
224
225
226
                    case MP_BC_LOAD_NULL:
                        PUSH(MP_OBJ_NULL);
                        break;

227
                    case MP_BC_LOAD_FAST_0:
228
                        PUSH(fastn[0]);
229
230
                        break;

231
                    case MP_BC_LOAD_FAST_1:
232
                        PUSH(fastn[-1]);
233
234
                        break;

235
                    case MP_BC_LOAD_FAST_2:
236
                        PUSH(fastn[-2]);
237
238
                        break;

239
                    case MP_BC_LOAD_FAST_N:
240
                        DECODE_UINT;
241
                        PUSH(fastn[-unum]);
242
243
                        break;

244
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
245
                        DECODE_UINT;
246
                        PUSH(mp_obj_cell_get(fastn[-unum]));
Damien's avatar
Damien committed
247
248
                        break;

249
                    case MP_BC_LOAD_NAME:
250
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
251
                        PUSH(mp_load_name(qst));
252
253
                        break;

254
                    case MP_BC_LOAD_GLOBAL:
255
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
256
                        PUSH(mp_load_global(qst));
257
258
                        break;

259
                    case MP_BC_LOAD_ATTR:
260
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
261
                        SET_TOP(mp_load_attr(TOP(), qst));
262
263
                        break;

264
                    case MP_BC_LOAD_METHOD:
265
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
266
                        mp_load_method(*sp, qst, sp);
267
                        sp += 1;
268
269
                        break;

270
                    case MP_BC_LOAD_BUILD_CLASS:
Damien George's avatar
Damien George committed
271
                        PUSH(mp_load_build_class());
272
273
                        break;

274
                    case MP_BC_STORE_FAST_0:
275
                        fastn[0] = POP();
276
277
                        break;

278
                    case MP_BC_STORE_FAST_1:
279
                        fastn[-1] = POP();
280
281
                        break;

282
                    case MP_BC_STORE_FAST_2:
283
                        fastn[-2] = POP();
284
285
                        break;

286
                    case MP_BC_STORE_FAST_N:
287
                        DECODE_UINT;
288
                        fastn[-unum] = POP();
289
290
                        break;

291
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
292
                        DECODE_UINT;
293
                        mp_obj_cell_set(fastn[-unum], POP());
Damien's avatar
Damien committed
294
295
                        break;

296
                    case MP_BC_STORE_NAME:
297
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
298
                        mp_store_name(qst, POP());
299
300
                        break;

301
                    case MP_BC_STORE_GLOBAL:
302
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
303
                        mp_store_global(qst, POP());
304
305
                        break;

306
                    case MP_BC_STORE_ATTR:
307
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
308
                        mp_store_attr(sp[0], qst, sp[-1]);
309
                        sp -= 2;
310
311
                        break;

312
                    case MP_BC_STORE_SUBSCR:
Damien George's avatar
Damien George committed
313
                        mp_store_subscr(sp[-1], sp[0], sp[-2]);
314
                        sp -= 3;
315
316
                        break;

317
318
319
320
321
                    case MP_BC_DELETE_FAST_N:
                        DECODE_UINT;
                        fastn[-unum] = MP_OBJ_NULL;
                        break;

322
323
                    case MP_BC_DELETE_NAME:
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
324
                        mp_delete_name(qst);
325
326
                        break;

327
328
                    case MP_BC_DELETE_SUBSCR:
                        mp_delete_subscr(sp[-1], sp[0]);
329
                        sp -= 2;
330
331
                        break;

332
                    case MP_BC_DUP_TOP:
333
                        obj1 = TOP();
334
335
336
                        PUSH(obj1);
                        break;

337
                    case MP_BC_DUP_TOP_TWO:
338
339
340
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
341
342
                        break;

343
                    case MP_BC_POP_TOP:
344
                        sp -= 1;
345
346
                        break;

347
                    case MP_BC_ROT_TWO:
348
                        obj1 = sp[0];
349
350
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
351
352
                        break;

353
                    case MP_BC_ROT_THREE:
354
                        obj1 = sp[0];
355
356
357
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
358
359
                        break;

360
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
361
362
                        DECODE_SLABEL;
                        ip += unum;
363
364
                        break;

365
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
366
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
367
                        if (mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
368
                            ip += unum;
369
370
371
                        }
                        break;

372
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
373
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
374
                        if (!mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
375
                            ip += unum;
376
377
378
                        }
                        break;

379
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
380
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
381
                        if (mp_obj_is_true(TOP())) {
Damien's avatar
Damien committed
382
383
                            ip += unum;
                        } else {
384
                            sp--;
Damien's avatar
Damien committed
385
386
387
                        }
                        break;

388
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
389
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
390
                        if (mp_obj_is_true(TOP())) {
391
                            sp--;
Damien's avatar
Damien committed
392
393
394
395
396
                        } else {
                            ip += unum;
                        }
                        break;

397
                        /* we are trying to get away without using this opcode
398
                    case MP_BC_SETUP_LOOP:
399
                        DECODE_UINT;
400
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
401
402
403
                        break;
                        */

404
                    case MP_BC_SETUP_WITH:
405
                        obj1 = TOP();
Damien George's avatar
Damien George committed
406
407
408
                        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);
409
                        PUSH_EXC_BLOCK();
410
411
412
413
                        PUSH(obj2);
                        break;

                    case MP_BC_WITH_CLEANUP: {
414
415
416
417
                        // 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.
418
419
420
421
422
                        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
423
                            obj2 = mp_call_function_n_kw(obj1, 3, 0, no_exc);
424
425
426
427
428
                        } 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
429
                                    obj2 = mp_call_function_n_kw(TOP(), 3, 0, no_exc);
430
431
432
433
434
                                    SET_TOP(retval);
                                    PUSH(cause);
                                    break;
                                }
                                case UNWIND_JUMP: {
Damien George's avatar
Damien George committed
435
                                    obj2 = mp_call_function_n_kw(sp[-2], 3, 0, no_exc);
436
437
438
439
440
441
442
443
444
445
446
                                    // 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
447
                            obj2 = mp_call_function_n_kw(sp[-3], 3, 0, args);
448
449
450
451
452
453
                            // 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
454
                            if (mp_obj_is_true(obj2)) {
455
456
457
458
                                // 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;
459
460
                                // ... pop "with" exception handler, and signal END_FINALLY
                                // to just execute finally handler normally (by pushing None
461
462
463
                                // on value stack)
                                assert(exc_sp >= exc_stack);
                                assert(exc_sp->opcode == MP_BC_SETUP_WITH);
464
                                POP_EXC_BLOCK();
465
466
467
468
469
470
471
472
                                PUSH(mp_const_none);
                            }
                        } else {
                            assert(0);
                        }
                        break;
                    }

473
474
475
476
477
478
479
480
481
                    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);
482
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
483
484
485
486
487
488
489
490
491
492
493
494
495
                                // 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
496
497
                        break;

Damien's avatar
Damien committed
498
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
499
                    case MP_BC_SETUP_EXCEPT:
500
                    case MP_BC_SETUP_FINALLY:
501
                        PUSH_EXC_BLOCK();
502
503
                        break;

504
                    case MP_BC_END_FINALLY:
505
                        // not fully implemented
506
507
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
508
                        // if TOS is an integer, does something else
509
                        // else error
510
                        if (mp_obj_is_exception_type(TOP())) {
511
                            nlr_raise(sp[-1]);
512
513
514
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
515
516
517
518
519
520
521
                        } 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;
522
523
                                case UNWIND_JUMP:
                                    goto unwind_jump;
524
525
                            }
                            assert(0);
526
527
528
                        } else {
                            assert(0);
                        }
529
530
                        break;

531
                    case MP_BC_GET_ITER:
Damien George's avatar
Damien George committed
532
                        SET_TOP(mp_getiter(TOP()));
533
534
                        break;

535
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
536
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
Damien George's avatar
Damien George committed
537
                        obj1 = mp_iternext_allow_raise(TOP());
538
                        if (obj1 == MP_OBJ_NULL) {
539
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
540
                            ip += unum; // jump to after for-block
541
542
543
544
545
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
546
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
547
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
548
                        // we are exiting an exception handler, so pop the last one of the exception-stack
549
                        assert(exc_sp >= exc_stack);
550
                        POP_EXC_BLOCK();
551
552
                        break;

553
                    // matched against: SETUP_EXCEPT
554
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
555
                        // TODO need to work out how blocks work etc
556
                        // pops block, checks it's an exception block, and restores the stack, saving the 3 exception values to local threadstate
557
                        assert(exc_sp >= exc_stack);
558
                        assert(currently_in_except_block);
559
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
560
                        //exc_sp--; // discard ip
561
                        POP_EXC_BLOCK();
562
                        //sp -= 3; // pop 3 exception values
563
564
                        break;

565
566
567
568
569
570
571
572
                    case MP_BC_NOT:
                        if (TOP() == mp_const_true) {
                            SET_TOP(mp_const_false);
                        } else {
                            SET_TOP(mp_const_true);
                        }
                        break;

573
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
574
                        unum = *ip++;
Damien George's avatar
Damien George committed
575
                        SET_TOP(mp_unary_op(unum, TOP()));
Damien's avatar
Damien committed
576
577
                        break;

578
                    case MP_BC_BINARY_OP:
579
580
                        unum = *ip++;
                        obj2 = POP();
581
                        obj1 = TOP();
Damien George's avatar
Damien George committed
582
                        SET_TOP(mp_binary_op(unum, obj1, obj2));
583
584
                        break;

585
                    case MP_BC_BUILD_TUPLE:
586
                        DECODE_UINT;
587
                        sp -= unum - 1;
588
                        SET_TOP(mp_obj_new_tuple(unum, sp));
589
590
                        break;

591
                    case MP_BC_BUILD_LIST:
592
                        DECODE_UINT;
593
                        sp -= unum - 1;
594
                        SET_TOP(mp_obj_new_list(unum, sp));
595
596
                        break;

597
                    case MP_BC_LIST_APPEND:
598
599
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
600
                        mp_obj_list_append(sp[-unum], sp[0]);
601
                        sp--;
602
603
                        break;

604
                    case MP_BC_BUILD_MAP:
605
                        DECODE_UINT;
606
                        PUSH(mp_obj_new_dict(unum));
607
608
                        break;

609
                    case MP_BC_STORE_MAP:
610
                        sp -= 2;
611
                        mp_obj_dict_store(sp[0], sp[2], sp[1]);
612
613
                        break;

614
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
615
                        DECODE_UINT;
616
                        // I think it's guaranteed by the compiler that sp[-unum - 1] is a map
617
                        mp_obj_dict_store(sp[-unum - 1], sp[0], sp[-1]);
618
                        sp -= 2;
Damien's avatar
Damien committed
619
620
                        break;

621
                    case MP_BC_BUILD_SET:
622
                        DECODE_UINT;
623
                        sp -= unum - 1;
624
                        SET_TOP(mp_obj_new_set(unum, sp));
625
626
                        break;

627
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
628
                        DECODE_UINT;
629
                        // I think it's guaranteed by the compiler that sp[-unum] is a set
630
                        mp_obj_set_store(sp[-unum], sp[0]);
631
                        sp--;
Damien's avatar
Damien committed
632
633
                        break;

634
#if MICROPY_ENABLE_SLICE
635
636
637
638
639
640
641
                    case MP_BC_BUILD_SLICE:
                        DECODE_UINT;
                        if (unum == 2) {
                            obj2 = POP();
                            obj1 = TOP();
                            SET_TOP(mp_obj_new_slice(obj1, obj2, NULL));
                        } else {
642
643
644
645
                            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;
646
647
                        }
                        break;
648
#endif
649

650
                    case MP_BC_UNPACK_SEQUENCE:
651
                        DECODE_UINT;
Damien George's avatar
Damien George committed
652
                        mp_unpack_sequence(sp[0], unum, sp);
653
                        sp += unum - 1;
654
655
                        break;

656
                    case MP_BC_MAKE_FUNCTION:
657
                        DECODE_UINT;
658
                        PUSH(mp_make_function_from_id(unum, MP_OBJ_NULL, MP_OBJ_NULL));
659
660
661
662
                        break;

                    case MP_BC_MAKE_FUNCTION_DEFARGS:
                        DECODE_UINT;
663
664
                        // Stack layout: def_dict def_tuple <- TOS
                        obj1 = POP();
665
                        SET_TOP(mp_make_function_from_id(unum, obj1, TOP()));
666
667
                        break;

668
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
669
                        DECODE_UINT;
670
671
                        // Stack layout: closure_tuple <- TOS
                        SET_TOP(mp_make_closure_from_id(unum, TOP(), MP_OBJ_NULL, MP_OBJ_NULL));
672
673
674
675
                        break;

                    case MP_BC_MAKE_CLOSURE_DEFARGS:
                        DECODE_UINT;
676
                        // Stack layout: def_dict def_tuple closure_tuple <- TOS
677
                        obj1 = POP();
678
679
                        obj2 = POP();
                        SET_TOP(mp_make_closure_from_id(unum, obj1, obj2, TOP()));
Damien's avatar
Damien committed
680
681
                        break;

682
                    case MP_BC_CALL_FUNCTION:
683
                        DECODE_UINT;
684
685
686
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe);
Damien George's avatar
Damien George committed
687
                        SET_TOP(mp_call_function_n_kw(*sp, unum & 0xff, (unum >> 8) & 0xff, sp + 1));
688
689
                        break;

690
691
692
693
694
695
                    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
696
697
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 2;
                        SET_TOP(mp_call_method_n_kw_var(false, unum, sp));
698
699
                        break;

700
                    case MP_BC_CALL_METHOD:
701
                        DECODE_UINT;
702
703
704
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 1;
Damien George's avatar
Damien George committed
705
                        SET_TOP(mp_call_method_n_kw(unum & 0xff, (unum >> 8) & 0xff, sp));
706
                        break;
707
708
709
710
711
712
713

                    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
714
715
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 3;
                        SET_TOP(mp_call_method_n_kw_var(true, unum, sp));
716
                        break;
717

718
                    case MP_BC_RETURN_VALUE:
719
720
unwind_return:
                        while (exc_sp >= exc_stack) {
721
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
722
723
724
725
726
727
728
729
730
731
732
733
734
735
                                // 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--;
                        }
736
                        nlr_pop();
737
                        *sp_in_out = sp;
738
                        assert(exc_sp == exc_stack - 1);
739
                        return MP_VM_RETURN_NORMAL;
740

741
742
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
743
744
                        assert(unum <= 1);
                        if (unum == 0) {
Damien George's avatar
Damien George committed
745
746
                            // search for the inner-most previous exception, to reraise it
                            obj1 = MP_OBJ_NULL;
747
                            for (mp_exc_stack_t *e = exc_sp; e >= exc_stack; e--) {
Damien George's avatar
Damien George committed
748
749
750
751
752
753
                                if (e->prev_exc != MP_OBJ_NULL) {
                                    obj1 = e->prev_exc;
                                    break;
                                }
                            }
                            if (obj1 == MP_OBJ_NULL) {
754
                                nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "No active exception to reraise"));
755
                            }
756
757
758
                        } else {
                            obj1 = POP();
                        }
759
                        nlr_raise(mp_make_raise_obj(obj1));
760

761
                    case MP_BC_YIELD_VALUE:
762
yield:
763
764
765
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
766
                        *exc_sp_in_out = MP_TAGPTR_MAKE(exc_sp, currently_in_except_block);
767
                        return MP_VM_RETURN_YIELD;
768

769
                    case MP_BC_YIELD_FROM: {
770
771
//#define EXC_MATCH(exc, type) MP_OBJ_IS_TYPE(exc, type)
#define EXC_MATCH(exc, type) mp_obj_exception_match(exc, type)
772
#define GENERATOR_EXIT_IF_NEEDED(t) if (t != MP_OBJ_NULL && EXC_MATCH(t, &mp_type_GeneratorExit)) { nlr_raise(t); }
773
774
                        mp_vm_return_kind_t ret_kind;
                        obj1 = POP();
775
                        mp_obj_t t_exc = MP_OBJ_NULL;
776
                        if (inject_exc != MP_OBJ_NULL) {
777
                            t_exc = inject_exc;
778
                            inject_exc = MP_OBJ_NULL;
779
                            ret_kind = mp_resume(TOP(), MP_OBJ_NULL, t_exc, &obj2);
780
                        } else {
781
                            ret_kind = mp_resume(TOP(), obj1, MP_OBJ_NULL, &obj2);
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
                        }

                        if (ret_kind == MP_VM_RETURN_YIELD) {
                            ip--;
                            PUSH(obj2);
                            goto yield;
                        }
                        if (ret_kind == MP_VM_RETURN_NORMAL) {
                            // Pop exhausted gen
                            sp--;
                            if (obj2 == MP_OBJ_NULL) {
                                // Optimize StopIteration
                                // TODO: get StopIteration's value
                                PUSH(mp_const_none);
                            } else {
                                PUSH(obj2);
                            }

800
801
802
                            // If we injected GeneratorExit downstream, then even
                            // if it was swallowed, we re-raise GeneratorExit
                            GENERATOR_EXIT_IF_NEEDED(t_exc);
803
804
805
806
807
808
                            break;
                        }
                        if (ret_kind == MP_VM_RETURN_EXCEPTION) {
                            // Pop exhausted gen
                            sp--;
                            if (EXC_MATCH(obj2, &mp_type_StopIteration)) {
809
810
811
812
                                PUSH(mp_obj_exception_get_value(obj2));
                                // If we injected GeneratorExit downstream, then even
                                // if it was swallowed, we re-raise GeneratorExit
                                GENERATOR_EXIT_IF_NEEDED(t_exc);
813
814
                                break;
                            } else {
815
                                nlr_raise(obj2);
816
817
818
819
                            }
                        }
                    }

820
                    case MP_BC_IMPORT_NAME:
821
822
                        DECODE_QSTR;
                        obj1 = POP();
Damien George's avatar
Damien George committed
823
                        SET_TOP(mp_import_name(qst, obj1, TOP()));
824
825
                        break;

826
                    case MP_BC_IMPORT_FROM:
827
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
828
                        obj1 = mp_import_from(TOP(), qst);
829
830
831
                        PUSH(obj1);
                        break;

832
                    case MP_BC_IMPORT_STAR:
Damien George's avatar
Damien George committed
833
                        mp_import_all(POP());
834
835
                        break