vm.c 39 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
    // 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;
    }

103
104
105
    // bytecode prelude: initialise closed over variables
    for (uint n_local = *ip++; n_local > 0; n_local--) {
        uint local_num = *ip++;
106
        state[n_state - 1 - local_num] = mp_obj_new_cell(state[n_state - 1 - local_num]);
Damien George's avatar
Damien George committed
107
108
109
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

245
246
247
248
249
250
251
252
253
254
                    case MP_BC_LOAD_FAST_CHECKED:
                        DECODE_UINT;
                        obj1 = fastn[-unum];
                        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;

255
                    case MP_BC_LOAD_DEREF:
Damien's avatar
Damien committed
256
                        DECODE_UINT;
257
258
259
260
261
                        obj1 = mp_obj_cell_get(fastn[-unum]);
                        if (obj1 == MP_OBJ_NULL) {
                            goto local_name_error;
                        }
                        PUSH(obj1);
Damien's avatar
Damien committed
262
263
                        break;

264
                    case MP_BC_LOAD_NAME:
265
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
266
                        PUSH(mp_load_name(qst));
267
268
                        break;

269
                    case MP_BC_LOAD_GLOBAL:
270
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
271
                        PUSH(mp_load_global(qst));
272
273
                        break;

274
                    case MP_BC_LOAD_ATTR:
275
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
276
                        SET_TOP(mp_load_attr(TOP(), qst));
277
278
                        break;

279
                    case MP_BC_LOAD_METHOD:
280
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
281
                        mp_load_method(*sp, qst, sp);
282
                        sp += 1;
283
284
                        break;

285
                    case MP_BC_LOAD_BUILD_CLASS:
Damien George's avatar
Damien George committed
286
                        PUSH(mp_load_build_class());
287
288
                        break;

289
                    case MP_BC_STORE_FAST_0:
290
                        fastn[0] = POP();
291
292
                        break;

293
                    case MP_BC_STORE_FAST_1:
294
                        fastn[-1] = POP();
295
296
                        break;

297
                    case MP_BC_STORE_FAST_2:
298
                        fastn[-2] = POP();
299
300
                        break;

301
                    case MP_BC_STORE_FAST_N:
302
                        DECODE_UINT;
303
                        fastn[-unum] = POP();
304
305
                        break;

306
                    case MP_BC_STORE_DEREF:
Damien's avatar
Damien committed
307
                        DECODE_UINT;
308
                        mp_obj_cell_set(fastn[-unum], POP());
Damien's avatar
Damien committed
309
310
                        break;

311
                    case MP_BC_STORE_NAME:
312
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
313
                        mp_store_name(qst, POP());
314
315
                        break;

316
                    case MP_BC_STORE_GLOBAL:
317
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
318
                        mp_store_global(qst, POP());
319
320
                        break;

321
                    case MP_BC_STORE_ATTR:
322
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
323
                        mp_store_attr(sp[0], qst, sp[-1]);
324
                        sp -= 2;
325
326
                        break;

327
                    case MP_BC_STORE_SUBSCR:
Damien George's avatar
Damien George committed
328
                        mp_store_subscr(sp[-1], sp[0], sp[-2]);
329
                        sp -= 3;
330
331
                        break;

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
                    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;

348
349
                    case MP_BC_DELETE_NAME:
                        DECODE_QSTR;
Damien George's avatar
Damien George committed
350
                        mp_delete_name(qst);
351
352
                        break;

353
354
355
356
357
                    case MP_BC_DELETE_GLOBAL:
                        DECODE_QSTR;
                        mp_delete_global(qst);
                        break;

358
                    case MP_BC_DUP_TOP:
359
                        obj1 = TOP();
360
361
362
                        PUSH(obj1);
                        break;

363
                    case MP_BC_DUP_TOP_TWO:
364
365
366
                        sp += 2;
                        sp[0] = sp[-2];
                        sp[-1] = sp[-3];
367
368
                        break;

369
                    case MP_BC_POP_TOP:
370
                        sp -= 1;
371
372
                        break;

373
                    case MP_BC_ROT_TWO:
374
                        obj1 = sp[0];
375
376
                        sp[0] = sp[-1];
                        sp[-1] = obj1;
377
378
                        break;

379
                    case MP_BC_ROT_THREE:
380
                        obj1 = sp[0];
381
382
383
                        sp[0] = sp[-1];
                        sp[-1] = sp[-2];
                        sp[-2] = obj1;
384
385
                        break;

386
                    case MP_BC_JUMP:
Damien's avatar
Damien committed
387
388
                        DECODE_SLABEL;
                        ip += unum;
389
390
                        break;

391
                    case MP_BC_POP_JUMP_IF_TRUE:
Damien's avatar
Damien committed
392
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
393
                        if (mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
394
                            ip += unum;
395
396
397
                        }
                        break;

398
                    case MP_BC_POP_JUMP_IF_FALSE:
Damien's avatar
Damien committed
399
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
400
                        if (!mp_obj_is_true(POP())) {
Damien's avatar
Damien committed
401
                            ip += unum;
402
403
404
                        }
                        break;

405
                    case MP_BC_JUMP_IF_TRUE_OR_POP:
Damien's avatar
Damien committed
406
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
407
                        if (mp_obj_is_true(TOP())) {
Damien's avatar
Damien committed
408
409
                            ip += unum;
                        } else {
410
                            sp--;
Damien's avatar
Damien committed
411
412
413
                        }
                        break;

414
                    case MP_BC_JUMP_IF_FALSE_OR_POP:
Damien's avatar
Damien committed
415
                        DECODE_SLABEL;
Damien George's avatar
Damien George committed
416
                        if (mp_obj_is_true(TOP())) {
417
                            sp--;
Damien's avatar
Damien committed
418
419
420
421
422
                        } else {
                            ip += unum;
                        }
                        break;

423
                        /* we are trying to get away without using this opcode
424
                    case MP_BC_SETUP_LOOP:
425
                        DECODE_UINT;
426
                        // push_block(MP_BC_SETUP_LOOP, ip + unum, sp)
427
428
429
                        break;
                        */

430
                    case MP_BC_SETUP_WITH:
431
                        obj1 = TOP();
Damien George's avatar
Damien George committed
432
433
434
                        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);
435
                        PUSH_EXC_BLOCK();
436
437
438
439
                        PUSH(obj2);
                        break;

                    case MP_BC_WITH_CLEANUP: {
440
441
442
443
                        // 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.
444
445
446
447
448
                        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
449
                            obj2 = mp_call_function_n_kw(obj1, 3, 0, no_exc);
450
451
452
453
454
                        } 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
455
                                    obj2 = mp_call_function_n_kw(TOP(), 3, 0, no_exc);
456
457
458
459
460
                                    SET_TOP(retval);
                                    PUSH(cause);
                                    break;
                                }
                                case UNWIND_JUMP: {
Damien George's avatar
Damien George committed
461
                                    obj2 = mp_call_function_n_kw(sp[-2], 3, 0, no_exc);
462
463
464
465
466
467
468
469
470
471
472
                                    // 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
473
                            obj2 = mp_call_function_n_kw(sp[-3], 3, 0, args);
474
475
476
477
478
479
                            // 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
480
                            if (mp_obj_is_true(obj2)) {
481
482
483
484
                                // 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;
485
486
                                // ... pop "with" exception handler, and signal END_FINALLY
                                // to just execute finally handler normally (by pushing None
487
488
489
                                // on value stack)
                                assert(exc_sp >= exc_stack);
                                assert(exc_sp->opcode == MP_BC_SETUP_WITH);
490
                                POP_EXC_BLOCK();
491
492
493
494
495
496
497
498
                                PUSH(mp_const_none);
                            }
                        } else {
                            assert(0);
                        }
                        break;
                    }

499
500
501
502
503
504
505
506
507
                    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);
508
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
509
510
511
512
513
514
515
516
517
518
519
520
521
                                // 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
522
523
                        break;

Damien's avatar
Damien committed
524
                    // matched against: POP_BLOCK or POP_EXCEPT (anything else?)
525
                    case MP_BC_SETUP_EXCEPT:
526
                    case MP_BC_SETUP_FINALLY:
527
                        PUSH_EXC_BLOCK();
528
529
                        break;

530
                    case MP_BC_END_FINALLY:
531
                        // not fully implemented
532
533
                        // if TOS is an exception, reraises the exception (3 values on TOS)
                        // if TOS is None, just pops it and continues
534
                        // if TOS is an integer, does something else
535
                        // else error
536
                        if (mp_obj_is_exception_type(TOP())) {
537
                            nlr_raise(sp[-1]);
538
539
540
                        }
                        if (TOP() == mp_const_none) {
                            sp--;
541
542
543
544
545
546
547
                        } 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;
548
549
                                case UNWIND_JUMP:
                                    goto unwind_jump;
550
551
                            }
                            assert(0);
552
553
554
                        } else {
                            assert(0);
                        }
555
556
                        break;

557
                    case MP_BC_GET_ITER:
Damien George's avatar
Damien George committed
558
                        SET_TOP(mp_getiter(TOP()));
559
560
                        break;

561
                    case MP_BC_FOR_ITER:
Damien's avatar
Damien committed
562
                        DECODE_ULABEL; // the jump offset if iteration finishes; for labels are always forward
Damien George's avatar
Damien George committed
563
                        obj1 = mp_iternext_allow_raise(TOP());
564
                        if (obj1 == MP_OBJ_NULL) {
565
                            --sp; // pop the exhausted iterator
Damien's avatar
Damien committed
566
                            ip += unum; // jump to after for-block
567
568
569
570
571
                        } else {
                            PUSH(obj1); // push the next iteration value
                        }
                        break;

Damien's avatar
Damien committed
572
                    // matched against: SETUP_EXCEPT, SETUP_FINALLY, SETUP_WITH
573
                    case MP_BC_POP_BLOCK:
Damien's avatar
Damien committed
574
                        // we are exiting an exception handler, so pop the last one of the exception-stack
575
                        assert(exc_sp >= exc_stack);
576
                        POP_EXC_BLOCK();
577
578
                        break;

579
                    // matched against: SETUP_EXCEPT
580
                    case MP_BC_POP_EXCEPT:
Damien's avatar
Damien committed
581
                        // TODO need to work out how blocks work etc
582
                        // pops block, checks it's an exception block, and restores the stack, saving the 3 exception values to local threadstate
583
                        assert(exc_sp >= exc_stack);
584
                        assert(currently_in_except_block);
585
                        //sp = (mp_obj_t*)(*exc_sp--);
Damien's avatar
Damien committed
586
                        //exc_sp--; // discard ip
587
                        POP_EXC_BLOCK();
588
                        //sp -= 3; // pop 3 exception values
589
590
                        break;

591
592
593
594
595
596
597
598
                    case MP_BC_NOT:
                        if (TOP() == mp_const_true) {
                            SET_TOP(mp_const_false);
                        } else {
                            SET_TOP(mp_const_true);
                        }
                        break;

599
                    case MP_BC_UNARY_OP:
Damien's avatar
Damien committed
600
                        unum = *ip++;
Damien George's avatar
Damien George committed
601
                        SET_TOP(mp_unary_op(unum, TOP()));
Damien's avatar
Damien committed
602
603
                        break;

604
                    case MP_BC_BINARY_OP:
605
606
                        unum = *ip++;
                        obj2 = POP();
607
                        obj1 = TOP();
Damien George's avatar
Damien George committed
608
                        SET_TOP(mp_binary_op(unum, obj1, obj2));
609
610
                        break;

611
                    case MP_BC_BUILD_TUPLE:
612
                        DECODE_UINT;
613
                        sp -= unum - 1;
614
                        SET_TOP(mp_obj_new_tuple(unum, sp));
615
616
                        break;

617
                    case MP_BC_BUILD_LIST:
618
                        DECODE_UINT;
619
                        sp -= unum - 1;
620
                        SET_TOP(mp_obj_new_list(unum, sp));
621
622
                        break;

623
                    case MP_BC_LIST_APPEND:
624
625
                        DECODE_UINT;
                        // I think it's guaranteed by the compiler that sp[unum] is a list
626
                        mp_obj_list_append(sp[-unum], sp[0]);
627
                        sp--;
628
629
                        break;

630
                    case MP_BC_BUILD_MAP:
631
                        DECODE_UINT;
632
                        PUSH(mp_obj_new_dict(unum));
633
634
                        break;

635
                    case MP_BC_STORE_MAP:
636
                        sp -= 2;
637
                        mp_obj_dict_store(sp[0], sp[2], sp[1]);
638
639
                        break;

640
                    case MP_BC_MAP_ADD:
Damien's avatar
Damien committed
641
                        DECODE_UINT;
642
                        // I think it's guaranteed by the compiler that sp[-unum - 1] is a map
643
                        mp_obj_dict_store(sp[-unum - 1], sp[0], sp[-1]);
644
                        sp -= 2;
Damien's avatar
Damien committed
645
646
                        break;

647
                    case MP_BC_BUILD_SET:
648
                        DECODE_UINT;
649
                        sp -= unum - 1;
650
                        SET_TOP(mp_obj_new_set(unum, sp));
651
652
                        break;

653
                    case MP_BC_SET_ADD:
Damien's avatar
Damien committed
654
                        DECODE_UINT;
655
                        // I think it's guaranteed by the compiler that sp[-unum] is a set
656
                        mp_obj_set_store(sp[-unum], sp[0]);
657
                        sp--;
Damien's avatar
Damien committed
658
659
                        break;

660
#if MICROPY_ENABLE_SLICE
661
662
663
664
665
666
667
                    case MP_BC_BUILD_SLICE:
                        DECODE_UINT;
                        if (unum == 2) {
                            obj2 = POP();
                            obj1 = TOP();
                            SET_TOP(mp_obj_new_slice(obj1, obj2, NULL));
                        } else {
668
669
670
671
                            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;
672
673
                        }
                        break;
674
#endif
675

676
                    case MP_BC_UNPACK_SEQUENCE:
677
                        DECODE_UINT;
Damien George's avatar
Damien George committed
678
                        mp_unpack_sequence(sp[0], unum, sp);
679
                        sp += unum - 1;
680
681
                        break;

682
683
684
685
686
687
                    case MP_BC_UNPACK_EX:
                        DECODE_UINT;
                        mp_unpack_ex(sp[0], unum, sp);
                        sp += (unum & 0xff) + ((unum >> 8) & 0xff);
                        break;

688
                    case MP_BC_MAKE_FUNCTION:
689
                        DECODE_UINT;
690
                        PUSH(mp_make_function_from_id(unum, MP_OBJ_NULL, MP_OBJ_NULL));
691
692
693
694
                        break;

                    case MP_BC_MAKE_FUNCTION_DEFARGS:
                        DECODE_UINT;
695
696
                        // Stack layout: def_dict def_tuple <- TOS
                        obj1 = POP();
697
                        SET_TOP(mp_make_function_from_id(unum, obj1, TOP()));
698
699
                        break;

700
                    case MP_BC_MAKE_CLOSURE:
Damien's avatar
Damien committed
701
                        DECODE_UINT;
702
703
                        // Stack layout: closure_tuple <- TOS
                        SET_TOP(mp_make_closure_from_id(unum, TOP(), MP_OBJ_NULL, MP_OBJ_NULL));
704
705
706
707
                        break;

                    case MP_BC_MAKE_CLOSURE_DEFARGS:
                        DECODE_UINT;
708
                        // Stack layout: def_dict def_tuple closure_tuple <- TOS
709
                        obj1 = POP();
710
711
                        obj2 = POP();
                        SET_TOP(mp_make_closure_from_id(unum, obj1, obj2, TOP()));
Damien's avatar
Damien committed
712
713
                        break;

714
                    case MP_BC_CALL_FUNCTION:
715
                        DECODE_UINT;
716
717
718
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe);
Damien George's avatar
Damien George committed
719
                        SET_TOP(mp_call_function_n_kw(*sp, unum & 0xff, (unum >> 8) & 0xff, sp + 1));
720
721
                        break;

722
723
724
725
726
727
                    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
728
729
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 2;
                        SET_TOP(mp_call_method_n_kw_var(false, unum, sp));
730
731
                        break;

732
                    case MP_BC_CALL_METHOD:
733
                        DECODE_UINT;
734
735
736
                        // unum & 0xff == n_positional
                        // (unum >> 8) & 0xff == n_keyword
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 1;
Damien George's avatar
Damien George committed
737
                        SET_TOP(mp_call_method_n_kw(unum & 0xff, (unum >> 8) & 0xff, sp));
738
                        break;
739
740
741
742
743
744
745

                    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
746
747
                        sp -= (unum & 0xff) + ((unum >> 7) & 0x1fe) + 3;
                        SET_TOP(mp_call_method_n_kw_var(true, unum, sp));
748
                        break;
749

750
                    case MP_BC_RETURN_VALUE:
751
752
unwind_return:
                        while (exc_sp >= exc_stack) {
753
                            if (exc_sp->opcode == MP_BC_SETUP_FINALLY || exc_sp->opcode == MP_BC_SETUP_WITH) {
754
755
756
757
758
759
760
761
762
763
764
765
766
767
                                // 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--;
                        }
768
                        nlr_pop();
769
                        *sp_in_out = sp;
770
                        assert(exc_sp == exc_stack - 1);
771
                        return MP_VM_RETURN_NORMAL;
772

773
774
                    case MP_BC_RAISE_VARARGS:
                        unum = *ip++;
775
776
                        assert(unum <= 1);
                        if (unum == 0) {
Damien George's avatar
Damien George committed
777
778
                            // search for the inner-most previous exception, to reraise it
                            obj1 = MP_OBJ_NULL;
779
                            for (mp_exc_stack_t *e = exc_sp; e >= exc_stack; e--) {
Damien George's avatar
Damien George committed
780
781
782
783
784
785
                                if (e->prev_exc != MP_OBJ_NULL) {
                                    obj1 = e->prev_exc;
                                    break;
                                }
                            }
                            if (obj1 == MP_OBJ_NULL) {
786
                                nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "No active exception to reraise"));
787
                            }
788
789
790
                        } else {
                            obj1 = POP();
                        }
791
                        nlr_raise(mp_make_raise_obj(obj1));
792

793
                    case MP_BC_YIELD_VALUE:
794
yield:
795
796
797
                        nlr_pop();
                        *ip_in_out = ip;
                        *sp_in_out = sp;
798
                        *exc_sp_in_out = MP_TAGPTR_MAKE(exc_sp, currently_in_except_block);
799
                        return MP_VM_RETURN_YIELD;
800

801
                    case MP_BC_YIELD_FROM: {
802
803
//#define EXC_MATCH(exc, type) MP_OBJ_IS_TYPE(exc, type)
#define EXC_MATCH(exc, type) mp_obj_exception_match(exc, type)
804
#define GENERATOR_EXIT_IF_NEEDED(t) if (t != MP_OBJ_NULL && EXC_MATCH(t, &mp_type_GeneratorExit)) { nlr_raise(t); }
805
806
                        mp_vm_return_kind_t ret_kind;
                        obj1 = POP();
807
                        mp_obj_t t_exc = MP_OBJ_NULL;
808
                        if (inject_exc != MP_OBJ_NULL) {
809
                            t_exc = inject_exc;
810
                            inject_exc = MP_OBJ_NULL;
811
                            ret_kind = mp_resume(TOP(), MP_OBJ_NULL, t_exc, &obj2);
812
                        } else {
813
                            ret_kind = mp_resume(TOP(), obj1, MP_OBJ_NULL, &obj2);
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
                        }

                        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);
                            }

832
833
834
                            // If we injected GeneratorExit downstream, then even
                            // if it was swallowed, we re-raise GeneratorExit
                            GENERATOR_EXIT_IF_NEEDED(t_exc);
835
836
837
838
839
840
                            break;
                        }
                        if (ret_kind == MP_VM_RETURN_EXCEPTION) {
                            // Pop exhausted gen
                            sp--;
                            if (EXC_MATCH(obj2, &mp_type_StopIteration)) {
841
842
843
844
                                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);
845
846
                                break;
                            } else {
847
                                nlr_raise(obj2);
848
849
850
851
                            }
                        }
                    }

852
                    case MP_BC_IMPORT_NAME:
853
854
                        DECODE_QSTR;
                        obj1 = POP();
Damien George's avatar
Damien George committed
855
                        SET_TOP(mp_import_name(qst, obj1, TOP()));