2014-05-03 23:27:38 +01:00
|
|
|
/*
|
2017-06-30 08:22:17 +01:00
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
2014-05-03 23:27:38 +01:00
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
2019-05-14 13:51:57 +01:00
|
|
|
* Copyright (c) 2014 Paul Sokolovsky
|
2014-05-03 23:27:38 +01:00
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
all: Unify header guard usage.
The code conventions suggest using header guards, but do not define how
those should look like and instead point to existing files. However, not
all existing files follow the same scheme, sometimes omitting header guards
altogether, sometimes using non-standard names, making it easy to
accidentally pick a "wrong" example.
This commit ensures that all header files of the MicroPython project (that
were not simply copied from somewhere else) follow the same pattern, that
was already present in the majority of files, especially in the py folder.
The rules are as follows.
Naming convention:
* start with the words MICROPY_INCLUDED
* contain the full path to the file
* replace special characters with _
In addition, there are no empty lines before #ifndef, between #ifndef and
one empty line before #endif. #endif is followed by a comment containing
the name of the guard macro.
py/grammar.h cannot use header guards by design, since it has to be
included multiple times in a single C file. Several other files also do not
need header guards as they are only used internally and guaranteed to be
included only once:
* MICROPY_MPHALPORT_H
* mpconfigboard.h
* mpconfigport.h
* mpthreadport.h
* pin_defs_*.h
* qstrdefs*.h
2017-06-29 22:14:58 +01:00
|
|
|
#ifndef MICROPY_INCLUDED_PY_BC_H
|
|
|
|
#define MICROPY_INCLUDED_PY_BC_H
|
2015-01-01 20:27:54 +00:00
|
|
|
|
|
|
|
#include "py/runtime.h"
|
2017-03-17 03:54:53 +00:00
|
|
|
#include "py/objfun.h"
|
2014-05-03 23:27:38 +01:00
|
|
|
|
2015-03-18 17:47:47 +00:00
|
|
|
// bytecode layout:
|
|
|
|
//
|
2019-09-16 13:12:59 +01:00
|
|
|
// func signature : var uint
|
|
|
|
// contains six values interleaved bit-wise as: xSSSSEAA [xFSSKAED repeated]
|
|
|
|
// x = extension another byte follows
|
|
|
|
// S = n_state - 1 number of entries in Python value stack
|
|
|
|
// E = n_exc_stack number of entries in exception stack
|
|
|
|
// F = scope_flags four bits of flags, MP_SCOPE_FLAG_xxx
|
|
|
|
// A = n_pos_args number of arguments this function takes
|
|
|
|
// K = n_kwonly_args number of keyword-only arguments this function takes
|
|
|
|
// D = n_def_pos_args number of default positional arguments
|
2015-03-18 17:47:47 +00:00
|
|
|
//
|
2019-09-25 06:45:47 +01:00
|
|
|
// prelude size : var uint
|
|
|
|
// contains two values interleaved bit-wise as: xIIIIIIC repeated
|
|
|
|
// x = extension another byte follows
|
|
|
|
// I = n_info number of bytes in source info section
|
|
|
|
// C = n_cells number of bytes/cells in closure section
|
|
|
|
//
|
|
|
|
// source info section:
|
|
|
|
// simple_name : var qstr
|
|
|
|
// source_file : var qstr
|
|
|
|
// <line number info>
|
|
|
|
//
|
|
|
|
// closure section:
|
|
|
|
// local_num0 : byte
|
|
|
|
// ... : byte
|
|
|
|
// local_numN : byte N = n_cells-1
|
|
|
|
//
|
|
|
|
// <word alignment padding> only needed if bytecode contains pointers
|
2015-03-18 17:47:47 +00:00
|
|
|
//
|
2019-09-25 06:45:47 +01:00
|
|
|
// <bytecode>
|
2015-03-18 17:47:47 +00:00
|
|
|
//
|
2015-10-23 01:23:11 +01:00
|
|
|
//
|
|
|
|
// constant table layout:
|
|
|
|
//
|
|
|
|
// argname0 : obj (qstr)
|
|
|
|
// ... : obj (qstr)
|
|
|
|
// argnameN : obj (qstr) N = num_pos_args + num_kwonly_args
|
|
|
|
// const0 : obj
|
|
|
|
// constN : obj
|
2015-03-18 17:47:47 +00:00
|
|
|
|
2019-09-16 13:12:59 +01:00
|
|
|
#define MP_BC_PRELUDE_SIG_ENCODE(S, E, scope, out_byte, out_env) \
|
2020-02-27 04:36:53 +00:00
|
|
|
do { \
|
|
|
|
/*// Get values to store in prelude */ \
|
|
|
|
size_t F = scope->scope_flags & MP_SCOPE_FLAG_ALL_SIG; \
|
|
|
|
size_t A = scope->num_pos_args; \
|
|
|
|
size_t K = scope->num_kwonly_args; \
|
|
|
|
size_t D = scope->num_def_pos_args; \
|
2019-09-16 13:12:59 +01:00
|
|
|
\
|
2020-02-27 04:36:53 +00:00
|
|
|
/* Adjust S to shrink range, to compress better */ \
|
|
|
|
S -= 1; \
|
2019-09-16 13:12:59 +01:00
|
|
|
\
|
2020-02-27 04:36:53 +00:00
|
|
|
/* Encode prelude */ \
|
|
|
|
/* xSSSSEAA */ \
|
|
|
|
uint8_t z = (S & 0xf) << 3 | (E & 1) << 2 | (A & 3); \
|
|
|
|
S >>= 4; \
|
|
|
|
E >>= 1; \
|
|
|
|
A >>= 2; \
|
|
|
|
while (S | E | F | A | K | D) { \
|
|
|
|
out_byte(out_env, 0x80 | z); \
|
|
|
|
/* xFSSKAED */ \
|
|
|
|
z = (F & 1) << 6 | (S & 3) << 4 | (K & 1) << 3 \
|
|
|
|
| (A & 1) << 2 | (E & 1) << 1 | (D & 1); \
|
|
|
|
S >>= 2; \
|
|
|
|
E >>= 1; \
|
|
|
|
F >>= 1; \
|
|
|
|
A >>= 1; \
|
|
|
|
K >>= 1; \
|
|
|
|
D >>= 1; \
|
|
|
|
} \
|
|
|
|
out_byte(out_env, z); \
|
|
|
|
} while (0)
|
2019-09-16 13:12:59 +01:00
|
|
|
|
|
|
|
#define MP_BC_PRELUDE_SIG_DECODE_INTO(ip, S, E, F, A, K, D) \
|
2020-02-27 04:36:53 +00:00
|
|
|
do { \
|
|
|
|
uint8_t z = *(ip)++; \
|
|
|
|
/* xSSSSEAA */ \
|
|
|
|
S = (z >> 3) & 0xf; \
|
|
|
|
E = (z >> 2) & 0x1; \
|
|
|
|
F = 0; \
|
|
|
|
A = z & 0x3; \
|
|
|
|
K = 0; \
|
|
|
|
D = 0; \
|
|
|
|
for (unsigned n = 0; z & 0x80; ++n) { \
|
|
|
|
z = *(ip)++; \
|
|
|
|
/* xFSSKAED */ \
|
|
|
|
S |= (z & 0x30) << (2 * n); \
|
|
|
|
E |= (z & 0x02) << n; \
|
|
|
|
F |= ((z & 0x40) >> 6) << n; \
|
|
|
|
A |= (z & 0x4) << n; \
|
|
|
|
K |= ((z & 0x08) >> 3) << n; \
|
|
|
|
D |= (z & 0x1) << n; \
|
|
|
|
} \
|
|
|
|
S += 1; \
|
|
|
|
} while (0)
|
2019-09-16 13:12:59 +01:00
|
|
|
|
|
|
|
#define MP_BC_PRELUDE_SIG_DECODE(ip) \
|
|
|
|
size_t n_state, n_exc_stack, scope_flags, n_pos_args, n_kwonly_args, n_def_pos_args; \
|
|
|
|
MP_BC_PRELUDE_SIG_DECODE_INTO(ip, n_state, n_exc_stack, scope_flags, n_pos_args, n_kwonly_args, n_def_pos_args)
|
|
|
|
|
2019-09-25 06:45:47 +01:00
|
|
|
#define MP_BC_PRELUDE_SIZE_ENCODE(I, C, out_byte, out_env) \
|
2020-02-27 04:36:53 +00:00
|
|
|
do { \
|
|
|
|
/* Encode bit-wise as: xIIIIIIC */ \
|
|
|
|
uint8_t z = 0; \
|
|
|
|
do { \
|
|
|
|
z = (I & 0x3f) << 1 | (C & 1); \
|
|
|
|
C >>= 1; \
|
|
|
|
I >>= 6; \
|
|
|
|
if (C | I) { \
|
|
|
|
z |= 0x80; \
|
|
|
|
} \
|
|
|
|
out_byte(out_env, z); \
|
|
|
|
} while (C | I); \
|
|
|
|
} while (0)
|
2019-09-25 06:45:47 +01:00
|
|
|
|
|
|
|
#define MP_BC_PRELUDE_SIZE_DECODE_INTO(ip, I, C) \
|
2020-02-27 04:36:53 +00:00
|
|
|
do { \
|
|
|
|
uint8_t z; \
|
|
|
|
C = 0; \
|
|
|
|
I = 0; \
|
|
|
|
for (unsigned n = 0;; ++n) { \
|
|
|
|
z = *(ip)++; \
|
|
|
|
/* xIIIIIIC */ \
|
|
|
|
C |= (z & 1) << n; \
|
|
|
|
I |= ((z & 0x7e) >> 1) << (6 * n); \
|
|
|
|
if (!(z & 0x80)) { \
|
|
|
|
break; \
|
|
|
|
} \
|
|
|
|
} \
|
|
|
|
} while (0)
|
2019-09-25 06:45:47 +01:00
|
|
|
|
|
|
|
#define MP_BC_PRELUDE_SIZE_DECODE(ip) \
|
|
|
|
size_t n_info, n_cell; \
|
|
|
|
MP_BC_PRELUDE_SIZE_DECODE_INTO(ip, n_info, n_cell)
|
|
|
|
|
2019-09-23 14:37:01 +01:00
|
|
|
// Sentinel value for mp_code_state_t.exc_sp_idx
|
|
|
|
#define MP_CODE_STATE_EXC_SP_IDX_SENTINEL ((uint16_t)-1)
|
|
|
|
|
|
|
|
// To convert mp_code_state_t.exc_sp_idx to/from a pointer to mp_exc_stack_t
|
|
|
|
#define MP_CODE_STATE_EXC_SP_IDX_FROM_PTR(exc_stack, exc_sp) ((exc_sp) + 1 - (exc_stack))
|
|
|
|
#define MP_CODE_STATE_EXC_SP_IDX_TO_PTR(exc_stack, exc_sp_idx) ((exc_stack) + (exc_sp_idx) - 1)
|
|
|
|
|
2019-08-14 15:09:36 +01:00
|
|
|
typedef struct _mp_bytecode_prelude_t {
|
|
|
|
uint n_state;
|
|
|
|
uint n_exc_stack;
|
|
|
|
uint scope_flags;
|
|
|
|
uint n_pos_args;
|
|
|
|
uint n_kwonly_args;
|
|
|
|
uint n_def_pos_args;
|
|
|
|
qstr qstr_block_name;
|
|
|
|
qstr qstr_source_file;
|
|
|
|
const byte *line_info;
|
|
|
|
const byte *opcodes;
|
|
|
|
} mp_bytecode_prelude_t;
|
|
|
|
|
2014-03-22 11:49:31 +00:00
|
|
|
// Exception stack entry
|
2016-08-27 14:21:00 +01:00
|
|
|
typedef struct _mp_exc_stack_t {
|
2014-03-22 11:49:31 +00:00
|
|
|
const byte *handler;
|
2019-09-23 14:32:31 +01:00
|
|
|
// bit 0 is currently unused
|
2014-12-22 12:49:57 +00:00
|
|
|
// bit 1 is whether the opcode was SETUP_WITH or SETUP_FINALLY
|
2014-03-22 21:20:07 +00:00
|
|
|
mp_obj_t *val_sp;
|
2019-09-23 14:32:31 +01:00
|
|
|
// Saved exception
|
2015-11-27 17:01:44 +00:00
|
|
|
mp_obj_base_t *prev_exc;
|
2014-03-30 00:57:09 +00:00
|
|
|
} mp_exc_stack_t;
|
2014-03-22 11:49:31 +00:00
|
|
|
|
2016-08-27 14:21:00 +01:00
|
|
|
typedef struct _mp_code_state_t {
|
2017-03-17 03:54:53 +00:00
|
|
|
// The fun_bc entry points to the underlying function object that is being executed.
|
|
|
|
// It is needed to access the start of bytecode and the const_table.
|
|
|
|
// It is also needed to prevent the GC from reclaiming the bytecode during execution,
|
|
|
|
// because the ip pointer below will always point to the interior of the bytecode.
|
|
|
|
mp_obj_fun_bc_t *fun_bc;
|
2014-05-31 14:50:46 +01:00
|
|
|
const byte *ip;
|
|
|
|
mp_obj_t *sp;
|
2019-09-24 06:57:08 +01:00
|
|
|
uint16_t n_state;
|
2019-09-23 14:37:01 +01:00
|
|
|
uint16_t exc_sp_idx;
|
2015-02-15 09:12:58 +00:00
|
|
|
mp_obj_dict_t *old_globals;
|
2015-03-27 23:14:44 +00:00
|
|
|
#if MICROPY_STACKLESS
|
2016-08-27 14:23:51 +01:00
|
|
|
struct _mp_code_state_t *prev;
|
2015-03-27 23:14:44 +00:00
|
|
|
#endif
|
2019-08-14 15:09:36 +01:00
|
|
|
#if MICROPY_PY_SYS_SETTRACE
|
|
|
|
struct _mp_code_state_t *prev_state;
|
|
|
|
struct _mp_obj_frame_t *frame;
|
|
|
|
#endif
|
2014-05-31 14:50:46 +01:00
|
|
|
// Variable-length
|
|
|
|
mp_obj_t state[0];
|
|
|
|
// Variable-length, never accessed by name, only as (void*)(state + n_state)
|
|
|
|
//mp_exc_stack_t exc_state[0];
|
2016-08-27 14:21:00 +01:00
|
|
|
} mp_code_state_t;
|
2014-05-31 14:50:46 +01:00
|
|
|
|
2014-09-04 14:44:01 +01:00
|
|
|
mp_uint_t mp_decode_uint(const byte **ptr);
|
2017-03-17 05:38:46 +00:00
|
|
|
mp_uint_t mp_decode_uint_value(const byte *ptr);
|
2017-06-09 04:31:57 +01:00
|
|
|
const byte *mp_decode_uint_skip(const byte *ptr);
|
2014-09-04 14:44:01 +01:00
|
|
|
|
2016-08-27 14:21:00 +01:00
|
|
|
mp_vm_return_kind_t mp_execute_bytecode(mp_code_state_t *code_state, volatile mp_obj_t inject_exc);
|
|
|
|
mp_code_state_t *mp_obj_fun_bc_prepare_codestate(mp_obj_t func, size_t n_args, size_t n_kw, const mp_obj_t *args);
|
2017-03-17 03:54:53 +00:00
|
|
|
void mp_setup_code_state(mp_code_state_t *code_state, size_t n_args, size_t n_kw, const mp_obj_t *args);
|
2015-10-23 01:23:11 +01:00
|
|
|
void mp_bytecode_print(const void *descr, const byte *code, mp_uint_t len, const mp_uint_t *const_table);
|
2017-01-27 01:34:09 +00:00
|
|
|
void mp_bytecode_print2(const byte *code, size_t len, const mp_uint_t *const_table);
|
2014-12-27 03:00:08 +00:00
|
|
|
const byte *mp_bytecode_print_str(const byte *ip);
|
2017-01-27 01:34:09 +00:00
|
|
|
#define mp_bytecode_print_inst(code, const_table) mp_bytecode_print2(code, 1, const_table)
|
2014-03-22 21:20:07 +00:00
|
|
|
|
2014-12-22 12:49:57 +00:00
|
|
|
// Helper macros to access pointer with least significant bits holding flags
|
2020-02-27 04:36:53 +00:00
|
|
|
#define MP_TAGPTR_PTR(x) ((void *)((uintptr_t)(x) & ~((uintptr_t)3)))
|
2015-11-27 12:54:30 +00:00
|
|
|
#define MP_TAGPTR_TAG0(x) ((uintptr_t)(x) & 1)
|
|
|
|
#define MP_TAGPTR_TAG1(x) ((uintptr_t)(x) & 2)
|
2020-02-27 04:36:53 +00:00
|
|
|
#define MP_TAGPTR_MAKE(ptr, tag) ((void *)((uintptr_t)(ptr) | (tag)))
|
2015-01-01 20:27:54 +00:00
|
|
|
|
2015-11-02 21:55:42 +00:00
|
|
|
#if MICROPY_PERSISTENT_CODE_LOAD || MICROPY_PERSISTENT_CODE_SAVE
|
|
|
|
|
2019-03-01 03:03:10 +00:00
|
|
|
uint mp_opcode_format(const byte *ip, size_t *opcode_size, bool count_var_uint);
|
2015-11-02 21:55:42 +00:00
|
|
|
|
|
|
|
#endif
|
|
|
|
|
2019-08-30 07:41:08 +01:00
|
|
|
static inline size_t mp_bytecode_get_source_line(const byte *line_info, size_t bc_offset) {
|
|
|
|
size_t source_line = 1;
|
|
|
|
size_t c;
|
|
|
|
while ((c = *line_info)) {
|
|
|
|
size_t b, l;
|
|
|
|
if ((c & 0x80) == 0) {
|
|
|
|
// 0b0LLBBBBB encoding
|
|
|
|
b = c & 0x1f;
|
|
|
|
l = c >> 5;
|
|
|
|
line_info += 1;
|
|
|
|
} else {
|
|
|
|
// 0b1LLLBBBB 0bLLLLLLLL encoding (l's LSB in second byte)
|
|
|
|
b = c & 0xf;
|
|
|
|
l = ((c << 4) & 0x700) | line_info[1];
|
|
|
|
line_info += 2;
|
|
|
|
}
|
|
|
|
if (bc_offset >= b) {
|
|
|
|
bc_offset -= b;
|
|
|
|
source_line += l;
|
|
|
|
} else {
|
|
|
|
// found source line corresponding to bytecode offset
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return source_line;
|
|
|
|
}
|
|
|
|
|
all: Unify header guard usage.
The code conventions suggest using header guards, but do not define how
those should look like and instead point to existing files. However, not
all existing files follow the same scheme, sometimes omitting header guards
altogether, sometimes using non-standard names, making it easy to
accidentally pick a "wrong" example.
This commit ensures that all header files of the MicroPython project (that
were not simply copied from somewhere else) follow the same pattern, that
was already present in the majority of files, especially in the py folder.
The rules are as follows.
Naming convention:
* start with the words MICROPY_INCLUDED
* contain the full path to the file
* replace special characters with _
In addition, there are no empty lines before #ifndef, between #ifndef and
one empty line before #endif. #endif is followed by a comment containing
the name of the guard macro.
py/grammar.h cannot use header guards by design, since it has to be
included multiple times in a single C file. Several other files also do not
need header guards as they are only used internally and guaranteed to be
included only once:
* MICROPY_MPHALPORT_H
* mpconfigboard.h
* mpconfigport.h
* mpthreadport.h
* pin_defs_*.h
* qstrdefs*.h
2017-06-29 22:14:58 +01:00
|
|
|
#endif // MICROPY_INCLUDED_PY_BC_H
|