emitbc.c 35.2 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
#if !MICROPY_EMIT_CPYTHON

39
40
41
#define BYTES_FOR_INT ((BYTES_PER_WORD * 8 + 6) / 7)
#define DUMMY_DATA_SIZE (BYTES_FOR_INT)

42
struct _emit_t {
43
    pass_kind_t pass : 8;
44
    mp_uint_t last_emit_was_return_value : 8;
45

Damien's avatar
Damien committed
46
47
48
49
    int stack_size;

    scope_t *scope;

50
51
    mp_uint_t last_source_line_offset;
    mp_uint_t last_source_line;
52

53
54
    mp_uint_t max_num_labels;
    mp_uint_t *label_offsets;
Damien's avatar
Damien committed
55

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

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

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

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

80
81
82
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) {
83
84
85
86
87
88
89
90
    // 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);
91
    byte *c = allocator(emit, buf + sizeof(buf) - p);
92
93
94
95
96
97
    while (p != buf + sizeof(buf) - 1) {
        *c++ = *p++ | 0x80;
    }
    *c = *p;
}

98
// all functions must go through this one to emit code info
99
STATIC byte *emit_get_cur_to_write_code_info(emit_t *emit, int num_bytes_to_write) {
100
    //printf("emit %d\n", num_bytes_to_write);
101
    if (emit->pass < MP_PASS_EMIT) {
102
103
104
105
106
107
108
109
        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
110
111
}

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

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

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

124
#if MICROPY_ENABLE_SOURCE_LINE
125
STATIC void emit_write_code_info_bytes_lines(emit_t *emit, mp_uint_t bytes_to_skip, mp_uint_t lines_to_skip) {
126
    assert(bytes_to_skip > 0 || lines_to_skip > 0);
127
    //printf("  %d %d\n", bytes_to_skip, lines_to_skip);
128
    while (bytes_to_skip > 0 || lines_to_skip > 0) {
129
130
131
132
133
134
135
136
137
138
139
140
141
142
        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;
        }
143
144
        bytes_to_skip -= b;
        lines_to_skip -= l;
145
    }
146
}
147
#endif
148
149

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

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

167
168
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
169
170
171
    c[0] = b1;
}

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

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

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

    // We store each 7 bits in a separate byte, and that's how many bytes needed
188
    byte buf[BYTES_FOR_INT];
189
190
191
192
193
194
195
196
197
198
199
200
201
202
    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;
    }

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

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

215
STATIC void emit_write_bytecode_prealigned_ptr(emit_t *emit, void *ptr) {
216
217
218
219
220
221
    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;
}

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

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

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

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

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

272
273
#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) {
274
275
276
277
    (void)emit;
    (void)op;
    (void)arg1;
    (void)arg2;
Damien George's avatar
Damien George committed
278
}
279
#endif
Damien George's avatar
Damien George committed
280

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

294
295
296
297
    // 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);
298
299
    }

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

304
305
306
307
    // 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
    {
308
309
310
311
312
313
314
315
316
317
        // 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.
318
        for (int i = 0; i < scope->num_pos_args + scope->num_kwonly_args; i++) {
319
320
321
322
323
324
325
326
327
            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));
328
329
330
331
        }
    }

    // bytecode prelude: local state size and exception stack size
332
    {
333
        mp_uint_t n_state = scope->num_locals + scope->stack_size;
334
335
336
337
338
339
        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;
        }
340
341
        emit_write_bytecode_uint(emit, n_state);
        emit_write_bytecode_uint(emit, scope->exc_stack_size);
342
343
344
    }

    // bytecode prelude: initialise closed over variables
Damien George's avatar
Damien George committed
345
346
347
    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) {
348
            assert(id->local_num < 255);
349
            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
350
351
        }
    }
352
    emit_write_bytecode_byte(emit, 255); // end of list sentinel
Damien George's avatar
Damien George committed
353
354
}

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

Damien George's avatar
Damien George committed
360
361
    // check stack is back to zero size
    if (emit->stack_size != 0) {
362
        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
363
364
    }

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

367
    if (emit->pass == MP_PASS_CODE_SIZE) {
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
        // 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
387
        emit->code_info_size = emit->code_info_offset;
388
389
        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
390

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

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

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

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

424
STATIC void emit_bc_pre(emit_t *emit, mp_int_t stack_size_delta) {
425
426
427
    if (emit->pass == MP_PASS_SCOPE) {
        return;
    }
428
    assert((mp_int_t)emit->stack_size + stack_size_delta >= 0);
429
430
431
    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
432
433
434
435
    }
    emit->last_emit_was_return_value = false;
}

436
void mp_emit_bc_label_assign(emit_t *emit, mp_uint_t l) {
437
    emit_bc_pre(emit, 0);
438
439
440
    if (emit->pass == MP_PASS_SCOPE) {
        return;
    }
441
    assert(l < emit->max_num_labels);
442
    if (emit->pass < MP_PASS_EMIT) {
443
        // assign label offset
444
        assert(emit->label_offsets[l] == (mp_uint_t)-1);
445
        emit->label_offsets[l] = emit->bytecode_offset;
446
447
    } else {
        // ensure label offset has not changed from MP_PASS_CODE_SIZE to MP_PASS_EMIT
448
449
        //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
450
451
452
    }
}

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

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

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

468
void mp_emit_bc_load_const_tok(emit_t *emit, mp_token_kind_t tok) {
469
    emit_bc_pre(emit, 1);
Damien's avatar
Damien committed
470
    switch (tok) {
471
472
473
        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;
474
        no_other_choice:
475
        case MP_TOKEN_ELLIPSIS: emit_write_bytecode_byte_ptr(emit, MP_BC_LOAD_CONST_OBJ, (void*)&mp_const_ellipsis_obj); break;
476
        default: assert(0); goto no_other_choice; // to help flow control analysis
Damien's avatar
Damien committed
477
478
479
    }
}

480
void mp_emit_bc_load_const_small_int(emit_t *emit, mp_int_t arg) {
481
    emit_bc_pre(emit, 1);
482
483
484
485
486
    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
487
488
}

489
void mp_emit_bc_load_const_str(emit_t *emit, qstr qst, bool bytes) {
490
    emit_bc_pre(emit, 1);
Damien's avatar
Damien committed
491
    if (bytes) {
492
        emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_CONST_BYTES, qst);
Damien's avatar
Damien committed
493
    } else {
494
        emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_CONST_STRING, qst);
Damien's avatar
Damien committed
495
496
497
    }
}

498
void mp_emit_bc_load_const_obj(emit_t *emit, void *obj) {
499
500
501
502
    emit_bc_pre(emit, 1);
    emit_write_bytecode_byte_ptr(emit, MP_BC_LOAD_CONST_OBJ, obj);
}

503
void mp_emit_bc_load_null(emit_t *emit) {
504
    emit_bc_pre(emit, 1);
505
    emit_write_bytecode_byte(emit, MP_BC_LOAD_NULL);
506
507
};

508
void mp_emit_bc_load_fast(emit_t *emit, qstr qst, mp_uint_t local_num) {
509
    (void)qst;
Damien's avatar
Damien committed
510
    assert(local_num >= 0);
511
    emit_bc_pre(emit, 1);
512
513
514
515
    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
516
517
518
    }
}

519
void mp_emit_bc_load_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
520
    (void)qst;
521
    emit_bc_pre(emit, 1);
522
    emit_write_bytecode_byte_uint(emit, MP_BC_LOAD_DEREF, local_num);
Damien's avatar
Damien committed
523
524
}

525
void mp_emit_bc_load_name(emit_t *emit, qstr qst) {
526
    (void)qst;
527
    emit_bc_pre(emit, 1);
528
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_NAME, qst);
529
530
531
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
532
533
}

534
void mp_emit_bc_load_global(emit_t *emit, qstr qst) {
535
    (void)qst;
536
    emit_bc_pre(emit, 1);
537
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_GLOBAL, qst);
538
539
540
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
541
542
}

543
void mp_emit_bc_load_attr(emit_t *emit, qstr qst) {
544
    emit_bc_pre(emit, 0);
545
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_ATTR, qst);
546
547
548
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
549
550
}

551
void mp_emit_bc_load_method(emit_t *emit, qstr qst) {
552
    emit_bc_pre(emit, 1);
553
    emit_write_bytecode_byte_qstr(emit, MP_BC_LOAD_METHOD, qst);
Damien's avatar
Damien committed
554
555
}

556
void mp_emit_bc_load_build_class(emit_t *emit) {
557
    emit_bc_pre(emit, 1);
558
    emit_write_bytecode_byte(emit, MP_BC_LOAD_BUILD_CLASS);
Damien's avatar
Damien committed
559
560
}

561
void mp_emit_bc_load_subscr(emit_t *emit) {
562
    emit_bc_pre(emit, -1);
563
    emit_write_bytecode_byte(emit, MP_BC_LOAD_SUBSCR);
564
565
}

566
void mp_emit_bc_store_fast(emit_t *emit, qstr qst, mp_uint_t local_num) {
567
    (void)qst;
Damien's avatar
Damien committed
568
    assert(local_num >= 0);
569
    emit_bc_pre(emit, -1);
570
571
572
573
    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
574
575
576
    }
}

577
void mp_emit_bc_store_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
578
    (void)qst;
579
    emit_bc_pre(emit, -1);
580
    emit_write_bytecode_byte_uint(emit, MP_BC_STORE_DEREF, local_num);
Damien's avatar
Damien committed
581
582
}

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

588
void mp_emit_bc_store_global(emit_t *emit, qstr qst) {
589
    emit_bc_pre(emit, -1);
590
    emit_write_bytecode_byte_qstr(emit, MP_BC_STORE_GLOBAL, qst);
Damien's avatar
Damien committed
591
592
}

593
void mp_emit_bc_store_attr(emit_t *emit, qstr qst) {
594
    emit_bc_pre(emit, -2);
595
    emit_write_bytecode_byte_qstr(emit, MP_BC_STORE_ATTR, qst);
596
597
598
    if (MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE) {
        emit_write_bytecode_byte(emit, 0);
    }
Damien's avatar
Damien committed
599
600
}

601
void mp_emit_bc_store_subscr(emit_t *emit) {
602
    emit_bc_pre(emit, -3);
603
    emit_write_bytecode_byte(emit, MP_BC_STORE_SUBSCR);
Damien's avatar
Damien committed
604
605
}

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

611
void mp_emit_bc_delete_deref(emit_t *emit, qstr qst, mp_uint_t local_num) {
612
    (void)qst;
613
    emit_write_bytecode_byte_uint(emit, MP_BC_DELETE_DEREF, local_num);
Damien's avatar
Damien committed
614
615
}

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

621
void mp_emit_bc_delete_global(emit_t *emit, qstr qst) {
622
    emit_bc_pre(emit, 0);
623
    emit_write_bytecode_byte_qstr(emit, MP_BC_DELETE_GLOBAL, qst);
Damien's avatar
Damien committed
624
625
}

626
627
628
629
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
630
631
}

632
633
634
635
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
636
637
}

638
void mp_emit_bc_dup_top(emit_t *emit) {
639
    emit_bc_pre(emit, 1);
640
    emit_write_bytecode_byte(emit, MP_BC_DUP_TOP);
Damien's avatar
Damien committed
641
642
}

643
void mp_emit_bc_dup_top_two(emit_t *emit) {
644
    emit_bc_pre(emit, 2);
645
    emit_write_bytecode_byte(emit, MP_BC_DUP_TOP_TWO);
Damien's avatar
Damien committed
646
647
}

648
void mp_emit_bc_pop_top(emit_t *emit) {
649
    emit_bc_pre(emit, -1);
650
    emit_write_bytecode_byte(emit, MP_BC_POP_TOP);
Damien's avatar
Damien committed
651
652
}

653
void mp_emit_bc_rot_two(emit_t *emit) {
654
    emit_bc_pre(emit, 0);
655
    emit_write_bytecode_byte(emit, MP_BC_ROT_TWO);
Damien's avatar
Damien committed
656
657
}

658
void mp_emit_bc_rot_three(emit_t *emit) {
659
    emit_bc_pre(emit, 0);
660
    emit_write_bytecode_byte(emit, MP_BC_ROT_THREE);
Damien's avatar
Damien committed
661
662
}

663
void mp_emit_bc_jump(emit_t *emit, mp_uint_t label) {
664
    emit_bc_pre(emit, 0);
665
    emit_write_bytecode_byte_signed_label(emit, MP_BC_JUMP, label);
Damien's avatar
Damien committed
666
667
}

668
void mp_emit_bc_pop_jump_if(emit_t *emit, bool cond, mp_uint_t label) {
669
    emit_bc_pre(emit, -1);
670
671
672
673
674
    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
675
676
}

677
void mp_emit_bc_jump_if_or_pop(emit_t *emit, bool cond, mp_uint_t label) {
678
    emit_bc_pre(emit, -1);
679
680
681
682
683
    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
684
685
}

686
void mp_emit_bc_unwind_jump(emit_t *emit, mp_uint_t label, mp_uint_t except_depth) {
687
    if (except_depth == 0) {
688
        emit_bc_pre(emit, 0);
689
690
691
692
693
694
695
696
        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);
697
    }
Damien's avatar
Damien committed
698
699
}

700
void mp_emit_bc_setup_with(emit_t *emit, mp_uint_t label) {
701
702
703
704
    // 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);
705
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_SETUP_WITH, label);
Damien's avatar
Damien committed
706
707
}

708
void mp_emit_bc_with_cleanup(emit_t *emit) {
709
    emit_bc_pre(emit, -4);
710
    emit_write_bytecode_byte(emit, MP_BC_WITH_CLEANUP);
Damien's avatar
Damien committed
711
712
}

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

718
void mp_emit_bc_setup_finally(emit_t *emit, mp_uint_t label) {
719
    emit_bc_pre(emit, 0);
720
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_SETUP_FINALLY, label);
Damien's avatar
Damien committed
721
722
}

723
void mp_emit_bc_end_finally(emit_t *emit) {
724
    emit_bc_pre(emit, -1);
725
    emit_write_bytecode_byte(emit, MP_BC_END_FINALLY);
Damien's avatar
Damien committed
726
727
}

728
void mp_emit_bc_get_iter(emit_t *emit) {
729
    emit_bc_pre(emit, 0);
730
    emit_write_bytecode_byte(emit, MP_BC_GET_ITER);
Damien's avatar
Damien committed
731
732
}

733
void mp_emit_bc_for_iter(emit_t *emit, mp_uint_t label) {
734
    emit_bc_pre(emit, 1);
735
    emit_write_bytecode_byte_unsigned_label(emit, MP_BC_FOR_ITER, label);
Damien's avatar
Damien committed
736
737
}

738
void mp_emit_bc_for_iter_end(emit_t *emit) {
739
    emit_bc_pre(emit, -1);
Damien's avatar
Damien committed
740
741
}

742
void mp_emit_bc_pop_block(emit_t *emit) {
743
    emit_bc_pre(emit, 0);
744
    emit_write_bytecode_byte(emit, MP_BC_POP_BLOCK);
Damien's avatar
Damien committed
745
746
}

747
void mp_emit_bc_pop_except(emit_t *emit) {
748
    emit_bc_pre(emit, 0);
749
    emit_write_bytecode_byte(emit, MP_BC_POP_EXCEPT);
Damien's avatar
Damien committed
750
751
}

752
void mp_emit_bc_unary_op(emit_t *emit, mp_unary_op_t op) {
Damien George's avatar
Damien George committed
753
    if (op == MP_UNARY_OP_NOT) {
754
        emit_bc_pre(emit, 0);
755
        emit_write_bytecode_byte(emit, MP_BC_UNARY_OP_MULTI + MP_UNARY_OP_BOOL);
756
        emit_bc_pre(emit, 0);
757
        emit_write_bytecode_byte(emit, MP_BC_NOT);
758
    } else {
759
        emit_bc_pre(emit, 0);
760
        emit_write_bytecode_byte(emit, MP_BC_UNARY_OP_MULTI + op);
761
    }
Damien's avatar
Damien committed
762
763
}

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

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

786
void mp_emit_bc_build_list(emit_t *emit, mp_uint_t n_args) {
787
    emit_bc_pre(emit, 1 - n_args);
788
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_LIST, n_args);
Damien's avatar
Damien committed
789
790
}

791
void mp_emit_bc_list_append(emit_t *emit, mp_uint_t list_stack_index) {
792
    emit_bc_pre(emit, -1);
793
    emit_write_bytecode_byte_uint(emit, MP_BC_LIST_APPEND, list_stack_index);
Damien's avatar
Damien committed
794
795
}

796
void mp_emit_bc_build_map(emit_t *emit, mp_uint_t n_args) {
797
    emit_bc_pre(emit, 1);
798
    emit_write_bytecode_byte_uint(emit, MP_BC_BUILD_MAP, n_args);
Damien's avatar
Damien committed
799
800
}

801
void mp_emit_bc_store_map(emit_t *emit) {
802
    emit_bc_pre(emit, -2);
803
    emit_write_bytecode_byte(emit, MP_BC_STORE_MAP);
Damien's avatar
Damien committed
804
805
}

806
void mp_emit_bc_map_add(emit_t *emit, mp_uint_t map_stack_index) {
807
    emit_bc_pre(emit, -2);
808
    emit_write_bytecode_byte_uint(emit, MP_BC_MAP_ADD, map_stack_index);
Damien's avatar
Damien committed
809
810
}