1/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26#ifndef MICROPY_INCLUDED_PY_EMIT_H
27#define MICROPY_INCLUDED_PY_EMIT_H
28
29#include "py/lexer.h"
30#include "py/scope.h"
31
32/* Notes on passes:
33 * We don't know exactly the opcodes in pass 1 because they depend on the
34 * closing over of variables (LOAD_CLOSURE, BUILD_TUPLE, MAKE_CLOSURE), which
35 * depends on determining the scope of variables in each function, and this
36 * is not known until the end of pass 1.
37 * As a consequence, we don't know the maximum stack size until the end of pass 2.
38 * This is problematic for some emitters (x64) since they need to know the maximum
39 * stack size to compile the entry to the function, and this affects code size.
40 */
41
42typedef enum {
43 MP_PASS_SCOPE = 1, // work out id's and their kind, and number of labels
44 MP_PASS_STACK_SIZE = 2, // work out maximum stack size
45 MP_PASS_CODE_SIZE = 3, // work out code size and label offsets
46 MP_PASS_EMIT = 4, // emit code
47} pass_kind_t;
48
49#define MP_EMIT_STAR_FLAG_SINGLE (0x01)
50#define MP_EMIT_STAR_FLAG_DOUBLE (0x02)
51
52#define MP_EMIT_BREAK_FROM_FOR (0x8000)
53
54// Kind for emit_id_ops->local()
55#define MP_EMIT_IDOP_LOCAL_FAST (0)
56#define MP_EMIT_IDOP_LOCAL_DEREF (1)
57
58// Kind for emit_id_ops->global()
59#define MP_EMIT_IDOP_GLOBAL_NAME (0)
60#define MP_EMIT_IDOP_GLOBAL_GLOBAL (1)
61
62// Kind for emit->import()
63#define MP_EMIT_IMPORT_NAME (0)
64#define MP_EMIT_IMPORT_FROM (1)
65#define MP_EMIT_IMPORT_STAR (2)
66
67// Kind for emit->subscr()
68#define MP_EMIT_SUBSCR_LOAD (0)
69#define MP_EMIT_SUBSCR_STORE (1)
70#define MP_EMIT_SUBSCR_DELETE (2)
71
72// Kind for emit->attr()
73#define MP_EMIT_ATTR_LOAD (0)
74#define MP_EMIT_ATTR_STORE (1)
75#define MP_EMIT_ATTR_DELETE (2)
76
77// Kind for emit->setup_block()
78#define MP_EMIT_SETUP_BLOCK_WITH (0)
79#define MP_EMIT_SETUP_BLOCK_EXCEPT (1)
80#define MP_EMIT_SETUP_BLOCK_FINALLY (2)
81
82// Kind for emit->build()
83#define MP_EMIT_BUILD_TUPLE (0)
84#define MP_EMIT_BUILD_LIST (1)
85#define MP_EMIT_BUILD_MAP (2)
86#define MP_EMIT_BUILD_SET (3)
87#define MP_EMIT_BUILD_SLICE (4)
88
89// Kind for emit->yield()
90#define MP_EMIT_YIELD_VALUE (0)
91#define MP_EMIT_YIELD_FROM (1)
92
93typedef struct _emit_t emit_t;
94
95typedef struct _mp_emit_method_table_id_ops_t {
96 void (*local)(emit_t *emit, qstr qst, mp_uint_t local_num, int kind);
97 void (*global)(emit_t *emit, qstr qst, int kind);
98} mp_emit_method_table_id_ops_t;
99
100typedef struct _emit_method_table_t {
101 #if MICROPY_DYNAMIC_COMPILER
102 emit_t *(*emit_new)(mp_obj_t * error_slot, uint *label_slot, mp_uint_t max_num_labels);
103 void (*emit_free)(emit_t *emit);
104 #endif
105
106 void (*start_pass)(emit_t *emit, pass_kind_t pass, scope_t *scope);
107 void (*end_pass)(emit_t *emit);
108 bool (*last_emit_was_return_value)(emit_t *emit);
109 void (*adjust_stack_size)(emit_t *emit, mp_int_t delta);
110 void (*set_source_line)(emit_t *emit, mp_uint_t line);
111
112 mp_emit_method_table_id_ops_t load_id;
113 mp_emit_method_table_id_ops_t store_id;
114 mp_emit_method_table_id_ops_t delete_id;
115
116 void (*label_assign)(emit_t *emit, mp_uint_t l);
117 void (*import)(emit_t *emit, qstr qst, int kind);
118 void (*load_const_tok)(emit_t *emit, mp_token_kind_t tok);
119 void (*load_const_small_int)(emit_t *emit, mp_int_t arg);
120 void (*load_const_str)(emit_t *emit, qstr qst);
121 void (*load_const_obj)(emit_t *emit, mp_obj_t obj);
122 void (*load_null)(emit_t *emit);
123 void (*load_method)(emit_t *emit, qstr qst, bool is_super);
124 void (*load_build_class)(emit_t *emit);
125 void (*subscr)(emit_t *emit, int kind);
126 void (*attr)(emit_t *emit, qstr qst, int kind);
127 void (*dup_top)(emit_t *emit);
128 void (*dup_top_two)(emit_t *emit);
129 void (*pop_top)(emit_t *emit);
130 void (*rot_two)(emit_t *emit);
131 void (*rot_three)(emit_t *emit);
132 void (*jump)(emit_t *emit, mp_uint_t label);
133 void (*pop_jump_if)(emit_t *emit, bool cond, mp_uint_t label);
134 void (*jump_if_or_pop)(emit_t *emit, bool cond, mp_uint_t label);
135 void (*unwind_jump)(emit_t *emit, mp_uint_t label, mp_uint_t except_depth);
136 void (*setup_block)(emit_t *emit, mp_uint_t label, int kind);
137 void (*with_cleanup)(emit_t *emit, mp_uint_t label);
138 void (*end_finally)(emit_t *emit);
139 void (*get_iter)(emit_t *emit, bool use_stack);
140 void (*for_iter)(emit_t *emit, mp_uint_t label);
141 void (*for_iter_end)(emit_t *emit);
142 void (*pop_except_jump)(emit_t *emit, mp_uint_t label, bool within_exc_handler);
143 void (*unary_op)(emit_t *emit, mp_unary_op_t op);
144 void (*binary_op)(emit_t *emit, mp_binary_op_t op);
145 void (*build)(emit_t *emit, mp_uint_t n_args, int kind);
146 void (*store_map)(emit_t *emit);
147 void (*store_comp)(emit_t *emit, scope_kind_t kind, mp_uint_t set_stack_index);
148 void (*unpack_sequence)(emit_t *emit, mp_uint_t n_args);
149 void (*unpack_ex)(emit_t *emit, mp_uint_t n_left, mp_uint_t n_right);
150 void (*make_function)(emit_t *emit, scope_t *scope, mp_uint_t n_pos_defaults, mp_uint_t n_kw_defaults);
151 void (*make_closure)(emit_t *emit, scope_t *scope, mp_uint_t n_closed_over, mp_uint_t n_pos_defaults, mp_uint_t n_kw_defaults);
152 void (*call_function)(emit_t *emit, mp_uint_t n_positional, mp_uint_t n_keyword, mp_uint_t star_flags);
153 void (*call_method)(emit_t *emit, mp_uint_t n_positional, mp_uint_t n_keyword, mp_uint_t star_flags);
154 void (*return_value)(emit_t *emit);
155 void (*raise_varargs)(emit_t *emit, mp_uint_t n_args);
156 void (*yield)(emit_t *emit, int kind);
157
158 // these methods are used to control entry to/exit from an exception handler
159 // they may or may not emit code
160 void (*start_except_handler)(emit_t *emit);
161 void (*end_except_handler)(emit_t *emit);
162} emit_method_table_t;
163
164static inline void mp_emit_common_get_id_for_load(scope_t *scope, qstr qst) {
165 scope_find_or_add_id(scope, qst, ID_INFO_KIND_GLOBAL_IMPLICIT);
166}
167
168void mp_emit_common_get_id_for_modification(scope_t *scope, qstr qst);
169void mp_emit_common_id_op(emit_t *emit, const mp_emit_method_table_id_ops_t *emit_method_table, scope_t *scope, qstr qst);
170
171extern const emit_method_table_t emit_bc_method_table;
172extern const emit_method_table_t emit_native_x64_method_table;
173extern const emit_method_table_t emit_native_x86_method_table;
174extern const emit_method_table_t emit_native_thumb_method_table;
175extern const emit_method_table_t emit_native_arm_method_table;
176extern const emit_method_table_t emit_native_xtensa_method_table;
177extern const emit_method_table_t emit_native_xtensawin_method_table;
178
179extern const mp_emit_method_table_id_ops_t mp_emit_bc_method_table_load_id_ops;
180extern const mp_emit_method_table_id_ops_t mp_emit_bc_method_table_store_id_ops;
181extern const mp_emit_method_table_id_ops_t mp_emit_bc_method_table_delete_id_ops;
182
183emit_t *emit_bc_new(void);
184emit_t *emit_native_x64_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
185emit_t *emit_native_x86_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
186emit_t *emit_native_thumb_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
187emit_t *emit_native_arm_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
188emit_t *emit_native_xtensa_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
189emit_t *emit_native_xtensawin_new(mp_obj_t *error_slot, uint *label_slot, mp_uint_t max_num_labels);
190
191void emit_bc_set_max_num_labels(emit_t *emit, mp_uint_t max_num_labels);
192
193void emit_bc_free(emit_t *emit);
194void emit_native_x64_free(emit_t *emit);
195void emit_native_x86_free(emit_t *emit);
196void emit_native_thumb_free(emit_t *emit);
197void emit_native_arm_free(emit_t *emit);
198void emit_native_xtensa_free(emit_t *emit);
199void emit_native_xtensawin_free(emit_t *emit);
200
201void mp_emit_bc_start_pass(emit_t *emit, pass_kind_t pass, scope_t *scope);
202void mp_emit_bc_end_pass(emit_t *emit);
203bool mp_emit_bc_last_emit_was_return_value(emit_t *emit);
204void mp_emit_bc_adjust_stack_size(emit_t *emit, mp_int_t delta);
205void mp_emit_bc_set_source_line(emit_t *emit, mp_uint_t line);
206
207void mp_emit_bc_load_local(emit_t *emit, qstr qst, mp_uint_t local_num, int kind);
208void mp_emit_bc_load_global(emit_t *emit, qstr qst, int kind);
209void mp_emit_bc_store_local(emit_t *emit, qstr qst, mp_uint_t local_num, int kind);
210void mp_emit_bc_store_global(emit_t *emit, qstr qst, int kind);
211void mp_emit_bc_delete_local(emit_t *emit, qstr qst, mp_uint_t local_num, int kind);
212void mp_emit_bc_delete_global(emit_t *emit, qstr qst, int kind);
213
214void mp_emit_bc_label_assign(emit_t *emit, mp_uint_t l);
215void mp_emit_bc_import(emit_t *emit, qstr qst, int kind);
216void mp_emit_bc_load_const_tok(emit_t *emit, mp_token_kind_t tok);
217void mp_emit_bc_load_const_small_int(emit_t *emit, mp_int_t arg);
218void mp_emit_bc_load_const_str(emit_t *emit, qstr qst);
219void mp_emit_bc_load_const_obj(emit_t *emit, mp_obj_t obj);
220void mp_emit_bc_load_null(emit_t *emit);
221void mp_emit_bc_load_method(emit_t *emit, qstr qst, bool is_super);
222void mp_emit_bc_load_build_class(emit_t *emit);
223void mp_emit_bc_subscr(emit_t *emit, int kind);
224void mp_emit_bc_attr(emit_t *emit, qstr qst, int kind);
225void mp_emit_bc_dup_top(emit_t *emit);
226void mp_emit_bc_dup_top_two(emit_t *emit);
227void mp_emit_bc_pop_top(emit_t *emit);
228void mp_emit_bc_rot_two(emit_t *emit);
229void mp_emit_bc_rot_three(emit_t *emit);
230void mp_emit_bc_jump(emit_t *emit, mp_uint_t label);
231void mp_emit_bc_pop_jump_if(emit_t *emit, bool cond, mp_uint_t label);
232void mp_emit_bc_jump_if_or_pop(emit_t *emit, bool cond, mp_uint_t label);
233void mp_emit_bc_unwind_jump(emit_t *emit, mp_uint_t label, mp_uint_t except_depth);
234void mp_emit_bc_setup_block(emit_t *emit, mp_uint_t label, int kind);
235void mp_emit_bc_with_cleanup(emit_t *emit, mp_uint_t label);
236void mp_emit_bc_end_finally(emit_t *emit);
237void mp_emit_bc_get_iter(emit_t *emit, bool use_stack);
238void mp_emit_bc_for_iter(emit_t *emit, mp_uint_t label);
239void mp_emit_bc_for_iter_end(emit_t *emit);
240void mp_emit_bc_pop_except_jump(emit_t *emit, mp_uint_t label, bool within_exc_handler);
241void mp_emit_bc_unary_op(emit_t *emit, mp_unary_op_t op);
242void mp_emit_bc_binary_op(emit_t *emit, mp_binary_op_t op);
243void mp_emit_bc_build(emit_t *emit, mp_uint_t n_args, int kind);
244void mp_emit_bc_store_map(emit_t *emit);
245void mp_emit_bc_store_comp(emit_t *emit, scope_kind_t kind, mp_uint_t list_stack_index);
246void mp_emit_bc_unpack_sequence(emit_t *emit, mp_uint_t n_args);
247void mp_emit_bc_unpack_ex(emit_t *emit, mp_uint_t n_left, mp_uint_t n_right);
248void mp_emit_bc_make_function(emit_t *emit, scope_t *scope, mp_uint_t n_pos_defaults, mp_uint_t n_kw_defaults);
249void mp_emit_bc_make_closure(emit_t *emit, scope_t *scope, mp_uint_t n_closed_over, mp_uint_t n_pos_defaults, mp_uint_t n_kw_defaults);
250void mp_emit_bc_call_function(emit_t *emit, mp_uint_t n_positional, mp_uint_t n_keyword, mp_uint_t star_flags);
251void mp_emit_bc_call_method(emit_t *emit, mp_uint_t n_positional, mp_uint_t n_keyword, mp_uint_t star_flags);
252void mp_emit_bc_return_value(emit_t *emit);
253void mp_emit_bc_raise_varargs(emit_t *emit, mp_uint_t n_args);
254void mp_emit_bc_yield(emit_t *emit, int kind);
255void mp_emit_bc_start_except_handler(emit_t *emit);
256void mp_emit_bc_end_except_handler(emit_t *emit);
257
258typedef struct _emit_inline_asm_t emit_inline_asm_t;
259
260typedef struct _emit_inline_asm_method_table_t {
261 #if MICROPY_DYNAMIC_COMPILER
262 emit_inline_asm_t *(*asm_new)(mp_uint_t max_num_labels);
263 void (*asm_free)(emit_inline_asm_t *emit);
264 #endif
265
266 void (*start_pass)(emit_inline_asm_t *emit, pass_kind_t pass, mp_obj_t *error_slot);
267 void (*end_pass)(emit_inline_asm_t *emit, mp_uint_t type_sig);
268 mp_uint_t (*count_params)(emit_inline_asm_t *emit, mp_uint_t n_params, mp_parse_node_t *pn_params);
269 bool (*label)(emit_inline_asm_t *emit, mp_uint_t label_num, qstr label_id);
270 void (*op)(emit_inline_asm_t *emit, qstr op, mp_uint_t n_args, mp_parse_node_t *pn_args);
271} emit_inline_asm_method_table_t;
272
273extern const emit_inline_asm_method_table_t emit_inline_thumb_method_table;
274extern const emit_inline_asm_method_table_t emit_inline_xtensa_method_table;
275
276emit_inline_asm_t *emit_inline_thumb_new(mp_uint_t max_num_labels);
277emit_inline_asm_t *emit_inline_xtensa_new(mp_uint_t max_num_labels);
278
279void emit_inline_thumb_free(emit_inline_asm_t *emit);
280void emit_inline_xtensa_free(emit_inline_asm_t *emit);
281
282#if MICROPY_WARNINGS
283void mp_emitter_warning(pass_kind_t pass, const char *msg);
284#else
285#define mp_emitter_warning(pass, msg)
286#endif
287
288#endif // MICROPY_INCLUDED_PY_EMIT_H
289