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_EMITGLUE_H
27#define MICROPY_INCLUDED_PY_EMITGLUE_H
28
29#include "py/obj.h"
30#include "py/bc.h"
31
32// These variables and functions glue the code emitters to the runtime.
33
34// These must fit in 8 bits; see scope.h
35enum {
36 MP_EMIT_OPT_NONE,
37 MP_EMIT_OPT_BYTECODE,
38 MP_EMIT_OPT_NATIVE_PYTHON,
39 MP_EMIT_OPT_VIPER,
40 MP_EMIT_OPT_ASM,
41};
42
43typedef enum {
44 MP_CODE_UNUSED,
45 MP_CODE_RESERVED,
46 MP_CODE_BYTECODE,
47 MP_CODE_NATIVE_PY,
48 MP_CODE_NATIVE_VIPER,
49 MP_CODE_NATIVE_ASM,
50} mp_raw_code_kind_t;
51
52typedef struct _mp_qstr_link_entry_t {
53 uint16_t off;
54 uint16_t qst;
55} mp_qstr_link_entry_t;
56
57typedef struct _mp_raw_code_t {
58 mp_uint_t kind : 3; // of type mp_raw_code_kind_t
59 mp_uint_t scope_flags : 7;
60 mp_uint_t n_pos_args : 11;
61 const void *fun_data;
62 const mp_uint_t *const_table;
63 #if MICROPY_PERSISTENT_CODE_SAVE
64 size_t fun_data_len;
65 uint16_t n_obj;
66 uint16_t n_raw_code;
67 #if MICROPY_PY_SYS_SETTRACE
68 mp_bytecode_prelude_t prelude;
69 // line_of_definition is a Python source line where the raw_code was
70 // created e.g. MP_BC_MAKE_FUNCTION. This is different from lineno info
71 // stored in prelude, which provides line number for first statement of
72 // a function. Required to properly implement "call" trace event.
73 mp_uint_t line_of_definition;
74 #endif
75 #if MICROPY_EMIT_MACHINE_CODE
76 uint16_t prelude_offset;
77 uint16_t n_qstr;
78 mp_qstr_link_entry_t *qstr_link;
79 #endif
80 #endif
81 #if MICROPY_EMIT_MACHINE_CODE
82 mp_uint_t type_sig; // for viper, compressed as 2-bit types; ret is MSB, then arg0, arg1, etc
83 #endif
84} mp_raw_code_t;
85
86mp_raw_code_t *mp_emit_glue_new_raw_code(void);
87
88void mp_emit_glue_assign_bytecode(mp_raw_code_t *rc, const byte *code,
89 #if MICROPY_PERSISTENT_CODE_SAVE || MICROPY_DEBUG_PRINTERS
90 size_t len,
91 #endif
92 const mp_uint_t *const_table,
93 #if MICROPY_PERSISTENT_CODE_SAVE
94 uint16_t n_obj, uint16_t n_raw_code,
95 #endif
96 mp_uint_t scope_flags);
97
98void mp_emit_glue_assign_native(mp_raw_code_t *rc, mp_raw_code_kind_t kind, void *fun_data, mp_uint_t fun_len,
99 const mp_uint_t *const_table,
100 #if MICROPY_PERSISTENT_CODE_SAVE
101 uint16_t prelude_offset,
102 uint16_t n_obj, uint16_t n_raw_code,
103 uint16_t n_qstr, mp_qstr_link_entry_t *qstr_link,
104 #endif
105 mp_uint_t n_pos_args, mp_uint_t scope_flags, mp_uint_t type_sig);
106
107mp_obj_t mp_make_function_from_raw_code(const mp_raw_code_t *rc, mp_obj_t def_args, mp_obj_t def_kw_args);
108mp_obj_t mp_make_closure_from_raw_code(const mp_raw_code_t *rc, mp_uint_t n_closed_over, const mp_obj_t *args);
109
110#endif // MICROPY_INCLUDED_PY_EMITGLUE_H
111