emitbc.c 35 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

xbe's avatar
xbe committed
27
#include <stdbool.h>
Damien's avatar
Damien committed
28
29
30
31
32
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>

33
#include "py/mpstate.h"
34
35
#include "py/emit.h"
#include "py/bc0.h"
Damien's avatar
Damien committed
36

37
38
39
#define BYTES_FOR_INT ((BYTES_PER_WORD * 8 + 6) / 7)
#define DUMMY_DATA_SIZE (BYTES_FOR_INT)

40
struct _emit_t {
41
    pass_kind_t pass : 8;
42
    mp_uint_t last_emit_was_return_value : 8;
43

Damien's avatar
Damien committed
44
45
46
47
    int stack_size;

    scope_t *scope;

48
49
    mp_uint_t last_source_line_offset;
    mp_uint_t last_source_line;
50

51
52
    mp_uint_t max_num_labels;
    mp_uint_t *label_offsets;
Damien's avatar
Damien committed
53

54
55
56
57
    mp_uint_t code_info_offset;
    mp_uint_t code_info_size;
    mp_uint_t bytecode_offset;
    mp_uint_t bytecode_size;
58
    byte *code_base; // stores both byte code and code info
59
    // Accessed as mp_uint_t, so must be aligned as such
60
    byte dummy_data[DUMMY_DATA_SIZE];
Damien's avatar
Damien committed
61
62
};

63
emit_t *emit_bc_new(void) {
64
    emit_t *emit = m_new0(emit_t, 1);
65
66
67
    return emit;
}

68
void emit_bc_set_max_num_labels(emit_t *emit, mp_uint_t max_num_labels) {
69
    emit->max_num_labels = max_num_labels;
70
    emit->label_offsets = m_new(mp_uint_t, emit->max_num_labels);
71
}
72

73
void emit_bc_free(emit_t *emit) {
74
    m_del(mp_uint_t, emit->label_offsets, emit->max_num_labels);
75
76
77
    m_del_obj(emit_t, emit);
}

78
79
80
typedef byte *(*emit_allocator_t)(emit_t *emit, int nbytes);

STATIC void emit_write_uint(emit_t *emit, emit_allocator_t allocator, mp_uint_t val) {
81
82
83
84
85
86
87
88
    // We store each 7 bits in a separate byte, and that's how many bytes needed
    byte buf[BYTES_FOR_INT];
    byte *p = buf + sizeof(buf);
    // We encode in little-ending order, but store in big-endian, to help decoding
    do {
        *--p = val & 0x7f;
        val >>= 7;
    } while (val != 0);
89
    byte *c = allocator(emit, buf + sizeof(buf) - p);
90
91
92
93
94
95
    while (p != buf + sizeof(buf) - 1) {
        *c++ = *p++ | 0x80;
    }
    *c = *p;
}

96
// all functions must go through this one to emit code info
97
STATIC byte *emit_get_cur_to_write_code_info(emit_t *emit, int num_bytes_to_write) {
98
    //printf("emit %d\n", num_bytes_to_write);
99
    if (emit->pass < MP_PASS_EMIT) {
100
101
102
103
104
105
106
107
        emit->code_info_offset += num_bytes_to_write;
        return emit->dummy_data;
    } else {
        assert(emit->code_info_offset + num_bytes_to_write <= emit->code_info_size);
        byte *c = emit->code_base + emit->code_info_offset;
        emit->code_info_offset += num_bytes_to_write;
        return c;
    }
Damien's avatar
Damien committed
108
109
}

110
STATIC void emit_align_code_info_to_machine_word(emit_t *emit) {
111
    emit->code_info_offset = (emit->code_info_offset + sizeof(mp_uint_t) - 1) & (~(sizeof(mp_uint_t) - 1));
112
113
}

114
STATIC void emit_write_code_info_uint(emit_t *emit, mp_uint_t val) {
115
116
117
    emit_write_uint(emit, emit_get_cur_to_write_code_info, val);
}

118
STATIC void emit_write_code_info_qstr(emit_t *emit, qstr qst) {
119
    emit_write_uint(emit, emit_get_cur_to_write_code_info, qst);
Damien's avatar
Damien committed
120
121
}

122
#if MICROPY_ENABLE_SOURCE_LINE
123
STATIC void emit_write_code_info_bytes_lines(emit_t *emit, mp_uint_t bytes_to_skip, mp_uint_t lines_to_skip) {
124
    assert(bytes_to_skip > 0 || lines_to_skip > 0);
125
    //printf("  %d %d\n", bytes_to_skip, lines_to_skip);
126
    while (bytes_to_skip > 0 || lines_to_skip > 0) {
127
128
129
130
131
132
133
134
135
136
137
138
139
140
        mp_uint_t b, l;
        if (lines_to_skip <= 6) {
            // use 0b0LLBBBBB encoding
            b = MIN(bytes_to_skip, 0x1f);
            l = MIN(lines_to_skip, 0x3);
            *emit_get_cur_to_write_code_info(emit, 1) = b | (l << 5);
        } else {
            // use 0b1LLLBBBB 0bLLLLLLLL encoding (l's LSB in second byte)
            b = MIN(bytes_to_skip, 0xf);
            l = MIN(lines_to_skip, 0x7ff);
            byte *ci = emit_get_cur_to_write_code_info(emit, 2);
            ci[0] = 0x80 | b | ((l >> 4) & 0x70);
            ci[1] = l;
        }
141
142
        bytes_to_skip -= b;
        lines_to_skip -= l;
143
    }
144
}
145
#endif
146
147

// all functions must go through this one to emit byte code
148
STATIC byte *emit_get_cur_to_write_bytecode(emit_t *emit, int num_bytes_to_write) {
Damien's avatar
Damien committed
149
    //printf("emit %d\n", num_bytes_to_write);
150
    if (emit->pass < MP_PASS_EMIT) {
151
        emit->bytecode_offset += num_bytes_to_write;
Damien's avatar
Damien committed
152
153
        return emit->dummy_data;
    } else {
154
155
156
        assert(emit->bytecode_offset + num_bytes_to_write <= emit->bytecode_size);
        byte *c = emit->code_base + emit->code_info_size + emit->bytecode_offset;
        emit->bytecode_offset += num_bytes_to_write;
Damien's avatar
Damien committed
157
158
159
160
        return c;
    }
}

161
STATIC void emit_align_bytecode_to_machine_word(emit_t *emit) {
162
    emit->bytecode_offset = (emit->bytecode_offset + sizeof(mp_uint_t) - 1) & (~(sizeof(mp_uint_t) - 1));
163
164
}

165
166
STATIC void emit_write_bytecode_byte(emit_t *emit, byte b1) {
    byte *c = emit_get_cur_to_write_bytecode(emit, 1);
Damien's avatar
Damien committed
167
168
169
    c[0] = b1;
}

170
STATIC void emit_write_bytecode_uint(emit_t *emit, mp_uint_t val) {
171
172
173
    emit_write_uint(emit, emit_get_cur_to_write_bytecode, val);
}

174
STATIC void emit_write_bytecode_byte_byte(emit_t *emit, byte b1, byte b2) {
Damien's avatar
Damien committed
175
    assert((b2 & (~0xff)) == 0);
176
    byte *c = emit_get_cur_to_write_bytecode(emit, 2);
Damien's avatar
Damien committed
177
178
179
180
    c[0] = b1;
    c[1] = b2;
}

181
// Similar to emit_write_bytecode_uint(), just some extra handling to encode sign
182
STATIC void emit_write_bytecode_byte_int(emit_t *emit, byte b1, mp_int_t num) {
183
    emit_write_bytecode_byte(emit, b1);
184
185

    // We store each 7 bits in a separate byte, and that's how many bytes needed
186
    byte buf[BYTES_FOR_INT];
187
188
189
190
191
192
193
194
195
196
197
198
199
200
    byte *p = buf + sizeof(buf);
    // We encode in little-ending order, but store in big-endian, to help decoding
    do {
        *--p = num & 0x7f;
        num >>= 7;
    } while (num != 0 && num != -1);
    // Make sure that highest bit we stored (mask 0x40) matches sign
    // of the number. If not, store extra byte just to encode sign
    if (num == -1 && (*p & 0x40) == 0) {
        *--p = 0x7f;
    } else if (num == 0 && (*p & 0x40) != 0) {
        *--p = 0;
    }

201
    byte *c = emit_get_cur_to_write_bytecode(emit, buf + sizeof(buf) - p);
202
203
204
205
    while (p != buf + sizeof(buf) - 1) {
        *c++ = *p++ | 0x80;
    }
    *c = *p;
Damien's avatar
Damien committed
206
207
}

208
STATIC void emit_write_bytecode_byte_uint(emit_t *emit, byte b, mp_uint_t val) {
209
    emit_write_bytecode_byte(emit, b);
210
    emit_write_uint(emit, emit_get_cur_to_write_bytecode, val);
Damien's avatar
Damien committed
211
212
}

213
STATIC void emit_write_bytecode_prealigned_ptr(emit_t *emit, void *ptr) {
214
215
216
217
218
219
    mp_uint_t *c = (mp_uint_t*)emit_get_cur_to_write_bytecode(emit, sizeof(mp_uint_t));
    // Verify thar c is already uint-aligned
    assert(c == MP_ALIGN(c, sizeof(mp_uint_t)));
    *c = (mp_uint_t)ptr;
}

220
// aligns the pointer so it is friendly to GC
221
STATIC void emit_write_bytecode_byte_ptr(emit_t *emit, byte b, void *ptr) {
222
223
    emit_write_bytecode_byte(emit, b);
    emit_align_bytecode_to_machine_word(emit);
224
    mp_uint_t *c = (mp_uint_t*)emit_get_cur_to_write_bytecode(emit, sizeof(mp_uint_t));
225
226
    // Verify thar c is already uint-aligned
    assert(c == MP_ALIGN(c, sizeof(mp_uint_t)));
227
    *c = (mp_uint_t)ptr;
228
229
}

230
/* currently unused
231
STATIC void emit_write_bytecode_byte_uint_uint(emit_t *emit, byte b, mp_uint_t num1, mp_uint_t num2) {
232
233
234
    emit_write_bytecode_byte(emit, b);
    emit_write_bytecode_byte_uint(emit, num1);
    emit_write_bytecode_byte_uint(emit, num2);
235
236
237
}
*/

238
STATIC void emit_write_bytecode_byte_qstr(emit_t *emit, byte b, qstr qst) {
239
    emit_write_bytecode_byte_uint(emit, b, qst);
Damien's avatar
Damien committed
240
241
}

Damien's avatar
Damien committed
242
// unsigned labels are relative to ip following this instruction, stored as 16 bits
243
STATIC void emit_write_bytecode_byte_unsigned_label(emit_t *emit, byte b1, mp_uint_t label) {
244
    mp_uint_t bytecode_offset;
245
    if (emit->pass < MP_PASS_EMIT) {
246
        bytecode_offset = 0;
Damien's avatar
Damien committed
247
    } else {
248
        bytecode_offset = emit->label_offsets[label] - emit->bytecode_offset - 3;
Damien's avatar
Damien committed
249
    }
250
    byte *c = emit_get_cur_to_write_bytecode(emit, 3);
Damien's avatar
Damien committed
251
    c[0] = b1;
252
253
    c[1] = bytecode_offset;
    c[2] = bytecode_offset >> 8;
Damien's avatar
Damien committed
254
255
256
}

// signed labels are relative to ip following this instruction, stored as 16 bits, in excess
257
STATIC void emit_write_bytecode_byte_signed_label(emit_t *emit, byte b1, mp_uint_t label) {
258
    int bytecode_offset;
259
    if (emit->pass < MP_PASS_EMIT) {
260
        bytecode_offset = 0;
Damien's avatar
Damien committed
261
    } else {
262
        bytecode_offset = emit->label_offsets[label] - emit->bytecode_offset - 3 + 0x8000;
Damien's avatar
Damien committed
263
    }
264
    byte *c = emit_get_cur_to_write_bytecode(emit, 3);
Damien's avatar
Damien committed
265
    c[0] = b1;
266
267
    c[1] = bytecode_offset;
    c[2] = bytecode_offset >> 8;
Damien's avatar
Damien committed
268
269
}

270
271
#if MICROPY_EMIT_NATIVE
STATIC void mp_emit_bc_set_native_type(emit_t *emit, mp_uint_t op, mp_uint_t arg1, qstr arg2) {
272
273
274
275
    (void)emit;
    (void)op;
    (void)arg1;
    (void)arg2;
Damien George's avatar
Damien George committed
276
}
277
#endif
Damien George's avatar
Damien George committed
278

279
void mp_emit_bc_start_pass(emit_t *emit, pass_kind_t pass, scope_t *scope) {
Damien George's avatar
Damien George committed
280
281
282
283
    emit->pass = pass;
    emit->stack_size = 0;
    emit->last_emit_was_return_value = false;
    emit->scope = scope;
284
285
    emit->last_source_line_offset = 0;
    emit->last_source_line = 1;
286
    if (pass < MP_PASS_EMIT) {
287
        memset(emit->label_offsets, -1, emit->max_num_labels * sizeof(mp_uint_t));
Damien George's avatar
Damien George committed
288
    }
289
    emit->bytecode_offset = 0;
290
291
    emit->code_info_offset = 0;

292
293
294
295
    // Write code info size as compressed uint.  If we are not in the final pass
    // then space for this uint is reserved in emit_bc_end_pass.
    if (pass == MP_PASS_EMIT) {
        emit_write_code_info_uint(emit, emit->code_info_size);
296
297
    }

298
    // write the name and source file of this function
299
    emit_write_code_info_qstr(emit, scope->simple_name);
300
    emit_write_code_info_qstr(emit, scope->source_file);
Damien George's avatar
Damien George committed
301

302
303
304
305
    // bytecode prelude: argument names (needed to resolve positional args passed as keywords)
    // we store them as full word-sized objects for efficient access in mp_setup_code_state
    // this is the start of the prelude and is guaranteed to be aligned on a word boundary
    {
306
307
308
309
310
311
312
313
314
315
        // For a given argument position (indexed by i) we need to find the
        // corresponding id_info which is a parameter, as it has the correct
        // qstr name to use as the argument name.  Note that it's not a simple
        // 1-1 mapping (ie i!=j in general) because of possible closed-over
        // variables.  In the case that the argument i has no corresponding
        // parameter we use "*" as its name (since no argument can ever be named
        // "*").  We could use a blank qstr but "*" is better for debugging.
        // Note: there is some wasted RAM here for the case of storing a qstr
        // for each closed-over variable, and maybe there is a better way to do
        // it, but that would require changes to mp_setup_code_state.
316
        for (int i = 0; i < scope->num_pos_args + scope->num_kwonly_args; i++) {
317
318
319
320
321
322
323
324
325
            qstr qst = MP_QSTR__star_;
            for (int j = 0; j < scope->id_info_len; ++j) {
                id_info_t *id = &scope->id_info[j];
                if ((id->flags & ID_FLAG_IS_PARAM) && id->local_num == i) {
                    qst = id->qst;
                    break;
                }
            }
            emit_write_bytecode_prealigned_ptr(emit, MP_OBJ_NEW_QSTR(qst));
326
327
328
329
        }
    }

    // bytecode prelude: local state size and exception stack size
330
    {
331
        mp_uint_t n_state = scope->num_locals + scope->stack_size;
332
333
334
335
336
337
        if (n_state == 0) {
            // Need at least 1 entry in the state, in the case an exception is
            // propagated through this function, the exception is returned in
            // the highest slot in the state (fastn[0], see vm.c).
            n_state = 1;
        }
338
339
        emit_write_bytecode_uint(emit, n_state);
        emit_write_bytecode_uint(emit, scope->exc_stack_size);
340
341
342
    }

    // bytecode prelude: initialise closed over variables
Damien George's avatar
Damien George committed
343
344
345
    for (int i = 0; i < scope->id_info_len; i++) {
        id_info_t *id = &scope->id_info[i];
        if (id->kind == ID_INFO_KIND_CELL) {
346
            assert(id->local_num < 255);
347
            emit_write_bytecode_byte(emit, id->local_num); // write the local which should be converted to a cell
Damien George's avatar
Damien George committed
348
349
        }
    }
350
    emit_write_bytecode_byte(emit, 255); // end of list sentinel
Damien George's avatar
Damien George committed
351
352
}

353
void mp_emit_bc_end_pass(emit_t *emit) {
354
355
356
357
    if (emit->pass == MP_PASS_SCOPE) {
        return;
    }

Damien George's avatar
Damien George committed
358
359
    // check stack is back to zero size
    if (emit->stack_size != 0) {
360
        mp_printf(&mp_plat_print, "ERROR: stack size not back to zero; got %d\n", emit->stack_size);
Damien George's avatar
Damien George committed
361
362
    }

363
    *emit_get_cur_to_write_code_info(emit, 1) = 0; // end of line number info
364

365
    if (emit->pass == MP_PASS_CODE_SIZE) {
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
        // Need to make sure we have enough room in the code-info block to write
        // the size of the code-info block.  Since the size is written as a
        // compressed uint, we don't know its size until we write it!  Thus, we
        // take the biggest possible value it could be and write that here.
        // Then there will be enough room to write the value, and any leftover
        // space will be absorbed in the alignment at the end of the code-info
        // block.
        mp_uint_t max_code_info_size =
            emit->code_info_offset  // current code-info size
            + BYTES_FOR_INT         // maximum space for compressed uint
            + BYTES_PER_WORD - 1;   // maximum space for alignment padding
        emit_write_code_info_uint(emit, max_code_info_size);

        // Align code-info so that following bytecode is aligned on a machine word.
        // We don't need to write anything here, it's just dead space between the
        // code-info block and the bytecode block that follows it.
        emit_align_code_info_to_machine_word(emit);

        // calculate size of total code-info + bytecode, in bytes
385
        emit->code_info_size = emit->code_info_offset;
386
387
        emit->bytecode_size = emit->bytecode_offset;
        emit->code_base = m_new0(byte, emit->code_info_size + emit->bytecode_size);
Damien George's avatar
Damien George committed
388

389
    } else if (emit->pass == MP_PASS_EMIT) {
390
391
        mp_emit_glue_assign_bytecode(emit->scope->raw_code, emit->code_base,
            emit->code_info_size + emit->bytecode_size,
392
            emit->scope->num_pos_args, emit->scope->num_kwonly_args,
393
            emit->scope->scope_flags);
Damien George's avatar
Damien George committed
394
395
396
    }
}

397
bool mp_emit_bc_last_emit_was_return_value(emit_t *emit) {
Damien's avatar
Damien committed
398
399
400
    return emit->last_emit_was_return_value;
}

401
void mp_emit_bc_adjust_stack_size(emit_t *emit, mp_int_t delta) {
402
    emit->stack_size += delta;
Damien's avatar
Damien committed
403
404
}

405
void mp_emit_bc_set_source_line(emit_t *emit, mp_uint_t source_line) {
406
    //printf("source: line %d -> %d  offset %d -> %d\n", emit->last_source_line, source_line, emit->last_source_line_offset, emit->bytecode_offset);
407
#if MICROPY_ENABLE_SOURCE_LINE
408
    if (MP_STATE_VM(mp_optimise_value) >= 3) {
409
410
411
        // If we compile with -O3, don't store line numbers.
        return;
    }
412
    if (source_line > emit->last_source_line) {
413
414
        mp_uint_t bytes_to_skip = emit->bytecode_offset - emit->last_source_line_offset;
        mp_uint_t lines_to_skip = source_line - emit->last_source_line;
415
        emit_write_code_info_bytes_lines(emit, bytes_to_skip, lines_to_skip);
416
        emit->last_source_line_offset = emit->bytecode_offset;
417
418
        emit->last_source_line = source_line;
    }
419
#endif
420
421
}

422
STATIC void emit_bc_pre(emit_t *emit, mp_int_t stack_size_delta) {
423
424
425
    if (emit->pass == MP_PASS_SCOPE) {
        return;
    }
426
    assert((mp_int_t)emit->stack_size + stack_size_delta >= 0);
427
428
429
    emit->stack_size += stack_size_delta;
    if (emit->stack_size > emit->scope->stack_size) {
        emit->scope->stack_size = emit->stack_size;
Damien's avatar
Damien committed
430
431
432
433
    }
    emit->last_emit_was_return_value = false;
}

434
void mp_emit_bc_label_assign(emit_t *emit, mp_uint_t l) {
435
    emit_bc_pre(emit, 0);
436
437
438
    if (emit->pass == MP_PASS_SCOPE) {
        return;
    }
439
    assert(l < emit->max_num_labels);
440
    if (emit->pass < MP_PASS_EMIT) {
441
        // assign label offset
442
        assert(emit->label_offsets[l] == (mp_uint_t)-1);
443
        emit->label_offsets[l] = emit->bytecode_offset;
444
445
    } else {
        // ensure label offset has not changed from MP_PASS_CODE_SIZE to MP_PASS_EMIT
446
447
        //printf("l%d: (at %d vs %d)\n", l, emit->bytecode_offset, emit->label_offsets[l]);
        assert(emit->label_offsets[l] == emit->bytecode_offset);
Damien's avatar
Damien committed
448
449
450
    }
}

451
void mp_emit_bc_import_name(emit_t *emit, qstr qst) {
452
    emit_bc_pre(emit, -1);
453
    emit_write_bytecode_byte_qstr(emit, MP_BC_IMPORT_NAME, qst);
Damien's avatar
Damien committed
454
455
}

456
void mp_emit_bc_import_from(emit_t *emit, qstr qst) {
457
    emit_bc_pre(emit, 1);
458
    emit_write_bytecode_byte_qstr(emit, MP_BC_IMPORT_FROM, qst);
Damien's avatar
Damien committed
459
460
}

461
void mp_emit_bc_import_star(emit_t *emit) {
462
    emit_bc_pre(emit, -1);
463
    emit_write_bytecode_byte(emit, MP_BC_IMPORT_STAR);
Damien's avatar
Damien committed
464
465
}

466
void mp_emit_bc_load_const_tok(emit_t *emit, mp_token_kind_t tok) {
467
    emit_bc_pre(emit, 1);
Damien's avatar
Damien committed
468
    switch (tok) {
469
470
471
        case MP_TOKEN_KW_FALSE: emit_write_bytecode_byte(emit, MP_BC_LOAD_CONST_FALSE); break;
        case MP_TOKEN_KW_NONE: emit_write_bytecode_byte(emit, MP_BC_LOAD_CONST_NONE); break;
        case MP_TOKEN_KW_TRUE: emit_write_bytecode_byte(emit, MP_BC_LOAD_CONST_TRUE); break;
472
        no_other_choice:
473
        case MP_TOKEN_ELLIPSIS: emit_write_bytecode_byte_ptr(emit, MP_BC_LOAD_CONST_OBJ, (void*)&mp_const_ellipsis_obj); break;
474
        default: assert(0); goto no_other_choice; // to help flow control analysis
Damien's avatar
Damien committed
475
476
477
    }
}

478
void mp_emit_bc_load_const_small_int(emit_t *emit, mp_int_t arg) {
479
    emit_bc_pre(emit, 1);
480
481
482
483
484
    if (-16 <= arg && arg <= 47) {
        emit_write_bytecode_byte(emit, MP_BC_LOAD_CONST_SMALL_INT_MULTI + 16 + arg);
    } else {
        emit_write_bytecode_byte_int(emit, MP_BC_LOAD_CONST_SMALL_INT, arg);
    }
Damien's avatar
Damien committed
485
486
}

487
void mp_emit_bc_load_const_str(emit_t *emit, qstr qst) {
488
    emit_bc_pre(emit, 1);
489
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_CONST_STRING, qst);
Damien's avatar
Damien committed
490
491
}

492
void mp_emit_bc_load_const_obj(emit_t *emit, void *obj) {
493
494
495
496
    emit_bc_pre(emit, 1);
    emit_write_bytecode_byte_ptr(emit, MP_BC_LOAD_CONST_OBJ, obj);
}

497
void mp_emit_bc_load_null(emit_t *emit) {
498
    emit_bc_pre(emit, 1);
499
    emit_write_bytecode_byte(emit, MP_BC_LOAD_NULL);
500
501
};

502
void mp_emit_bc_load_fast(emit_t *emit, qstr qst, mp_uint_t local_num) {
503
    (void)qst;
Damien's avatar
Damien committed
504
    assert(local_num >= 0);
505
    emit_bc_pre(emit, 1);
506
507
508
509
    if (local_num <= 15) {
        emit_write_bytecode_byte(emit, MP_BC_LOAD_FAST_MULTI + local_num);
    } else {
        emit_write_bytecode_byte_uint(emit, MP_BC_LOAD_FAST_N, local_num);
Damien's avatar
Damien committed
510
511
512
    }
}

513
void mp_emit_bc_load_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
514
    (void)qst;
515
    emit_bc_pre(emit, 1);
516
    emit_write_bytecode_byte_uint(emit, MP_BC_LOAD_DEREF, local_num);
Damien's avatar
Damien committed
517
518
}

519
void mp_emit_bc_load_name(emit_t *emit, qstr qst) {
520
    (void)qst;
521
    emit_bc_pre(emit, 1);
522
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_NAME, qst);
523
524
525
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
526
527
}

528
void mp_emit_bc_load_global(emit_t *emit, qstr qst) {
529
    (void)qst;
530
    emit_bc_pre(emit, 1);
531
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_GLOBAL, qst);
532
533
534
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
535
536
}

537
void mp_emit_bc_load_attr(emit_t *emit, qstr qst) {
538
    emit_bc_pre(emit, 0);
539
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_ATTR, qst);
540
541
542
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
543
544
}

545
void mp_emit_bc_load_method(emit_t *emit, qstr qst) {
546
    emit_bc_pre(emit, 1);
547
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_METHOD, qst);
Damien's avatar
Damien committed
548
549
}

550
void mp_emit_bc_load_build_class(emit_t *emit) {
551
    emit_bc_pre(emit, 1);
552
    emit_write_bytecode_byte(emit, MP_BC_LOAD_BUILD_CLASS);
Damien's avatar
Damien committed
553
554
}

555
void mp_emit_bc_load_subscr(emit_t *emit) {
556
    emit_bc_pre(emit, -1);
557
    emit_write_bytecode_byte(emit, MP_BC_LOAD_SUBSCR);
558
559
}

560
void mp_emit_bc_store_fast(emit_t *emit, qstr qst, mp_uint_t local_num) {
561
    (void)qst;
Damien's avatar
Damien committed
562
    assert(local_num >= 0);
563
    emit_bc_pre(emit, -1);
564
565
566
567
    if (local_num <= 15) {
        emit_write_bytecode_byte(emit, MP_BC_STORE_FAST_MULTI + local_num);
    } else {
        emit_write_bytecode_byte_uint(emit, MP_BC_STORE_FAST_N, local_num);
Damien's avatar
Damien committed
568
569
570
    }
}

571
void mp_emit_bc_store_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
572
    (void)qst;
573
    emit_bc_pre(emit, -1);
574
    emit_write_bytecode_byte_uint(emit, MP_BC_STORE_DEREF, local_num);
Damien's avatar
Damien committed
575
576
}

577
void mp_emit_bc_store_name(emit_t *emit, qstr qst) {
578
    emit_bc_pre(emit, -1);
579
    emit_write_bytecode_byte_qstr(emit, MP_BC_STORE_NAME, qst);
Damien's avatar
Damien committed
580
581
}

582
void mp_emit_bc_store_global(emit_t *emit, qstr qst) {
583
    emit_bc_pre(emit, -1);
584
    emit_write_bytecode_byte_qstr(emit, MP_BC_STORE_GLOBAL, qst);
Damien's avatar
Damien committed
585
586
}

587
void mp_emit_bc_store_attr(emit_t *emit, qstr qst) {
588
    emit_bc_pre(emit, -2);
589
    emit_write_bytecode_byte_qstr(emit, MP_BC_STORE_ATTR, qst);
590
591
592
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
593
594
}

595
void mp_emit_bc_store_subscr(emit_t *emit) {
596
    emit_bc_pre(emit, -3);
597
    emit_write_bytecode_byte(emit, MP_BC_STORE_SUBSCR);
Damien's avatar
Damien committed
598
599
}

600
void mp_emit_bc_delete_fast(emit_t *emit, qstr qst, mp_uint_t local_num) {
601
    (void)qst;
602
    emit_write_bytecode_byte_uint(emit, MP_BC_DELETE_FAST, local_num);
Damien's avatar
Damien committed
603
604
}

605
void mp_emit_bc_delete_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
606
    (void)qst;
607
    emit_write_bytecode_byte_uint(emit, MP_BC_DELETE_DEREF, local_num);
Damien's avatar
Damien committed
608
609
}

610
void mp_emit_bc_delete_name(emit_t *emit, qstr qst) {
611
    emit_bc_pre(emit, 0);
612
    emit_write_bytecode_byte_qstr(emit, MP_BC_DELETE_NAME, qst);
Damien's avatar
Damien committed
613
614
}

615
void mp_emit_bc_delete_global(emit_t *emit, qstr qst) {
616
    emit_bc_pre(emit, 0);
617
    emit_write_bytecode_byte_qstr(emit, MP_BC_DELETE_GLOBAL, qst);
Damien's avatar
Damien committed
618
619
}

620
621
622
623
void mp_emit_bc_delete_attr(emit_t *emit, qstr qst) {
    mp_emit_bc_load_null(emit);
    mp_emit_bc_rot_two(emit);
    mp_emit_bc_store_attr(emit, qst);
Damien's avatar
Damien committed
624
625
}

626
627
628
629
void mp_emit_bc_delete_subscr(emit_t *emit) {
    mp_emit_bc_load_null(emit);
    mp_emit_bc_rot_three(emit);
    mp_emit_bc_store_subscr(emit);
Damien's avatar
Damien committed
630
631
}

632
void mp_emit_bc_dup_top(emit_t *emit) {
633
    emit_bc_pre(emit, 1);
634
    emit_write_bytecode_byte(emit, MP_BC_DUP_TOP);
Damien's avatar
Damien committed
635
636
}

637
void mp_emit_bc_dup_top_two(emit_t *emit) {
638
    emit_bc_pre(emit, 2);
639
    emit_write_bytecode_byte(emit, MP_BC_DUP_TOP_TWO);
Damien's avatar
Damien committed
640
641
}

642
void mp_emit_bc_pop_top(emit_t *emit) {
643
    emit_bc_pre(emit, -1);
644
    emit_write_bytecode_byte(emit, MP_BC_POP_TOP);
Damien's avatar
Damien committed
645
646
}

647
void mp_emit_bc_rot_two(emit_t *emit) {
648
    emit_bc_pre(emit, 0);
649
    emit_write_bytecode_byte(emit, MP_BC_ROT_TWO);
Damien's avatar
Damien committed
650
651
}

652
void mp_emit_bc_rot_three(emit_t *emit) {
653
    emit_bc_pre(emit, 0);
654
    emit_write_bytecode_byte(emit, MP_BC_ROT_THREE);
Damien's avatar
Damien committed
655
656
}

657
void mp_emit_bc_jump(emit_t *emit, mp_uint_t label) {
658
    emit_bc_pre(emit, 0);
659
    emit_write_bytecode_byte_signed_label(emit, MP_BC_JUMP, label);
Damien's avatar
Damien committed
660
661
}

662
void mp_emit_bc_pop_jump_if(emit_t *emit, bool cond, mp_uint_t label) {
663
    emit_bc_pre(emit, -1);
664
665
666
667
668
    if (cond) {
        emit_write_bytecode_byte_signed_label(emit, MP_BC_POP_JUMP_IF_TRUE, label);
    } else {
        emit_write_bytecode_byte_signed_label(emit, MP_BC_POP_JUMP_IF_FALSE, label);
    }
Damien's avatar
Damien committed
669
670
}

671
void mp_emit_bc_jump_if_or_pop(emit_t *emit, bool cond, mp_uint_t label) {
672
    emit_bc_pre(emit, -1);
673
674
675
676
677
    if (cond) {
        emit_write_bytecode_byte_signed_label(emit, MP_BC_JUMP_IF_TRUE_OR_POP, label);
    } else {
        emit_write_bytecode_byte_signed_label(emit, MP_BC_JUMP_IF_FALSE_OR_POP, label);
    }
Damien's avatar
Damien committed
678
679
}

680
void mp_emit_bc_unwind_jump(emit_t *emit, mp_uint_t label, mp_uint_t except_depth) {
681
    if (except_depth == 0) {
682
        emit_bc_pre(emit, 0);
683
684
685
686
687
688
689
690
        if (label & MP_EMIT_BREAK_FROM_FOR) {
            // need to pop the iterator if we are breaking out of a for loop
            emit_write_bytecode_byte(emit, MP_BC_POP_TOP);
        }
        emit_write_bytecode_byte_signed_label(emit, MP_BC_JUMP, label & ~MP_EMIT_BREAK_FROM_FOR);
    } else {
        emit_write_bytecode_byte_signed_label(emit, MP_BC_UNWIND_JUMP, label & ~MP_EMIT_BREAK_FROM_FOR);
        emit_write_bytecode_byte(emit, ((label & MP_EMIT_BREAK_FROM_FOR) ? 0x80 : 0) | except_depth);
691
    }
Damien's avatar
Damien committed
692
693
}

694
void mp_emit_bc_setup_with(emit_t *emit, mp_uint_t label) {
695
696
697
698
    // TODO We can probably optimise the amount of needed stack space, since
    // we don't actually need 4 slots during the entire with block, only in
    // the cleanup handler in certain cases.  It needs some thinking.
    emit_bc_pre(emit, 4);
699
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_SETUP_WITH, label);
Damien's avatar
Damien committed
700
701
}

702
void mp_emit_bc_with_cleanup(emit_t *emit) {
703
    emit_bc_pre(emit, -4);
704
    emit_write_bytecode_byte(emit, MP_BC_WITH_CLEANUP);
Damien's avatar
Damien committed
705
706
}

707
void mp_emit_bc_setup_except(emit_t *emit, mp_uint_t label) {
708
    emit_bc_pre(emit, 0);
709
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_SETUP_EXCEPT, label);
Damien's avatar
Damien committed
710
711
}

712
void mp_emit_bc_setup_finally(emit_t *emit, mp_uint_t label) {
713
    emit_bc_pre(emit, 0);
714
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_SETUP_FINALLY, label);
Damien's avatar
Damien committed
715
716
}

717
void mp_emit_bc_end_finally(emit_t *emit) {
718
    emit_bc_pre(emit, -1);
719
    emit_write_bytecode_byte(emit, MP_BC_END_FINALLY);
Damien's avatar
Damien committed
720
721
}

722
void mp_emit_bc_get_iter(emit_t *emit) {
723
    emit_bc_pre(emit, 0);
724
    emit_write_bytecode_byte(emit, MP_BC_GET_ITER);
Damien's avatar
Damien committed
725
726
}

727
void mp_emit_bc_for_iter(emit_t *emit, mp_uint_t label) {
728
    emit_bc_pre(emit, 1);
729
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_FOR_ITER, label);
Damien's avatar
Damien committed
730
731
}

732
void mp_emit_bc_for_iter_end(emit_t *emit) {
733
    emit_bc_pre(emit, -1);
Damien's avatar
Damien committed
734
735
}

736
void mp_emit_bc_pop_block(emit_t *emit) {
737
    emit_bc_pre(emit, 0);
738
    emit_write_bytecode_byte(emit, MP_BC_POP_BLOCK);
Damien's avatar
Damien committed
739
740
}

741
void mp_emit_bc_pop_except(emit_t *emit) {
742
    emit_bc_pre(emit, 0);
743
    emit_write_bytecode_byte(emit, MP_BC_POP_EXCEPT);
Damien's avatar
Damien committed
744
745
}

746
void mp_emit_bc_unary_op(emit_t *emit, mp_unary_op_t op) {
Damien George's avatar
Damien George committed
747
    if (op == MP_UNARY_OP_NOT) {
748
        emit_bc_pre(emit, 0);
749
        emit_write_bytecode_byte(emit, MP_BC_UNARY_OP_MULTI + MP_UNARY_OP_BOOL);
750
        emit_bc_pre(emit, 0);
751
        emit_write_bytecode_byte(emit, MP_BC_NOT);
752
    } else {
753
        emit_bc_pre(emit, 0);
754
        emit_write_bytecode_byte(emit, MP_BC_UNARY_OP_MULTI + op);
755
    }
Damien's avatar
Damien committed
756
757
}

758
void mp_emit_bc_binary_op(emit_t *emit, mp_binary_op_t op) {
759
    bool invert = false;
Damien George's avatar
Damien George committed
760
    if (op == MP_BINARY_OP_NOT_IN) {
761
        invert = true;
Damien George's avatar
Damien George committed
762
763
        op = MP_BINARY_OP_IN;
    } else if (op == MP_BINARY_OP_IS_NOT) {
764
        invert = true;
Damien George's avatar
Damien George committed
765
        op = MP_BINARY_OP_IS;
766
    }
767
    emit_bc_pre(emit, -1);
768
    emit_write_bytecode_byte(emit, MP_BC_BINARY_OP_MULTI + op);
769
    if (invert) {
770
        emit_bc_pre(emit, 0);
771
        emit_write_bytecode_byte(emit, MP_BC_NOT);
772
    }
Damien's avatar
Damien committed
773
774
}

775
void mp_emit_bc_build_tuple(emit_t *emit, mp_uint_t n_args) {
776
    emit_bc_pre(emit, 1 - n_args);
777
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_TUPLE, n_args);
Damien's avatar
Damien committed
778
779
}

780
void mp_emit_bc_build_list(emit_t *emit, mp_uint_t n_args) {
781
    emit_bc_pre(emit, 1 - n_args);
782
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_LIST, n_args);
Damien's avatar
Damien committed
783
784
}

785
void mp_emit_bc_list_append(emit_t *emit, mp_uint_t list_stack_index) {
786
    emit_bc_pre(emit, -1);
787
    emit_write_bytecode_byte_uint(emit, MP_BC_LIST_APPEND, list_stack_index);
Damien's avatar
Damien committed
788
789
}

790
void mp_emit_bc_build_map(emit_t *emit, mp_uint_t n_args) {
791
    emit_bc_pre(emit, 1);
792
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_MAP, n_args);
Damien's avatar
Damien committed
793
794
}

795
void mp_emit_bc_store_map(emit_t *emit) {
796
    emit_bc_pre(emit, -2);
797
    emit_write_bytecode_byte(emit, MP_BC_STORE_MAP);
Damien's avatar
Damien committed
798
799
}

800
void mp_emit_bc_map_add(emit_t *emit, mp_uint_t map_stack_index) {
801
    emit_bc_pre(emit, -2);
802
    emit_write_bytecode_byte_uint(emit, MP_BC_MAP_ADD, map_stack_index);
Damien's avatar
Damien committed
803
804
}

805
#if MICROPY_PY_BUILTINS_SET
806
void mp_emit_bc_build_set(emit_t *emit, mp_uint_t n_args) {
807
    emit_bc_pre(emit, 1 - n_args);
808
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_SET, n_args);
Damien's avatar
Damien committed