vm.c 39.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"
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
245
246
247
248
249
250
251
252
253
                    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;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

857
                    case MP_BC_IMPORT_FROM: