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
|
|
|
|
*
|
|
|
|
* 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_RUNTIME0_H
|
|
|
|
#define MICROPY_INCLUDED_PY_RUNTIME0_H
|
2014-05-03 23:27:38 +01:00
|
|
|
|
2018-09-27 14:27:53 +01:00
|
|
|
// The first four must fit in 8 bits, see emitbc.c
|
|
|
|
// The remaining must fit in 16 bits, see scope.h
|
2019-09-16 13:12:59 +01:00
|
|
|
#define MP_SCOPE_FLAG_GENERATOR (0x01)
|
2015-08-17 22:39:03 +01:00
|
|
|
#define MP_SCOPE_FLAG_VARKEYWORDS (0x02)
|
2019-09-16 13:12:59 +01:00
|
|
|
#define MP_SCOPE_FLAG_VARARGS (0x04)
|
2015-10-22 23:45:37 +01:00
|
|
|
#define MP_SCOPE_FLAG_DEFKWARGS (0x08)
|
py: Fix native functions so they run with their correct globals context.
Prior to this commit a function compiled with the native decorator
@micropython.native would not work correctly when accessing global
variables, because the globals dict was not being set upon function entry.
This commit fixes this problem by, upon function entry, setting as the
current globals dict the globals dict context the function was defined
within, as per normal Python semantics, and as bytecode does. Upon
function exit the original globals dict is restored.
In order to restore the globals dict when an exception is raised the native
function must guard its internals with an nlr_push/nlr_pop pair. Because
this push/pop is relatively expensive, in both C stack usage for the
nlr_buf_t and CPU execution time, the implementation here optimises things
as much as possible. First, the compiler keeps track of whether a function
even needs to access global variables. Using this information the native
emitter then generates three different kinds of code:
1. no globals used, no exception handlers: no nlr handling code and no
setting of the globals dict.
2. globals used, no exception handlers: an nlr_buf_t is allocated on the
C stack but it is not used if the globals dict is unchanged, saving
execution time because nlr_push/nlr_pop don't need to run.
3. function has exception handlers, may use globals: an nlr_buf_t is
allocated and nlr_push/nlr_pop are always called.
In the end, native functions that don't access globals and don't have
exception handlers will run more efficiently than those that do.
Fixes issue #1573.
2018-09-13 13:03:48 +01:00
|
|
|
#define MP_SCOPE_FLAG_REFGLOBALS (0x10) // used only if native emitter enabled
|
2018-09-27 14:27:53 +01:00
|
|
|
#define MP_SCOPE_FLAG_HASCONSTS (0x20) // used only if native emitter enabled
|
|
|
|
#define MP_SCOPE_FLAG_VIPERRET_POS (6) // 3 bits used for viper return type
|
2014-02-15 19:33:11 +00:00
|
|
|
|
2014-08-15 16:45:41 +01:00
|
|
|
// types for native (viper) function signature
|
|
|
|
#define MP_NATIVE_TYPE_OBJ (0x00)
|
|
|
|
#define MP_NATIVE_TYPE_BOOL (0x01)
|
|
|
|
#define MP_NATIVE_TYPE_INT (0x02)
|
|
|
|
#define MP_NATIVE_TYPE_UINT (0x03)
|
2016-02-02 23:16:05 +00:00
|
|
|
#define MP_NATIVE_TYPE_PTR (0x04)
|
|
|
|
#define MP_NATIVE_TYPE_PTR8 (0x05)
|
|
|
|
#define MP_NATIVE_TYPE_PTR16 (0x06)
|
|
|
|
#define MP_NATIVE_TYPE_PTR32 (0x07)
|
2014-08-15 16:45:41 +01:00
|
|
|
|
2013-12-21 18:17:45 +00:00
|
|
|
typedef enum {
|
2017-09-26 00:35:19 +01:00
|
|
|
// These ops may appear in the bytecode. Changing this group
|
|
|
|
// in any way requires changing the bytecode version.
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_UNARY_OP_POSITIVE,
|
|
|
|
MP_UNARY_OP_NEGATIVE,
|
|
|
|
MP_UNARY_OP_INVERT,
|
|
|
|
MP_UNARY_OP_NOT,
|
2017-09-26 00:35:19 +01:00
|
|
|
|
|
|
|
// Following ops cannot appear in the bytecode
|
2017-10-03 13:34:28 +01:00
|
|
|
MP_UNARY_OP_NUM_BYTECODE,
|
2017-09-26 00:35:19 +01:00
|
|
|
|
2017-10-03 13:34:28 +01:00
|
|
|
MP_UNARY_OP_BOOL = MP_UNARY_OP_NUM_BYTECODE, // __bool__
|
2017-09-26 00:35:19 +01:00
|
|
|
MP_UNARY_OP_LEN, // __len__
|
|
|
|
MP_UNARY_OP_HASH, // __hash__; must return a small int
|
2017-09-17 22:06:43 +01:00
|
|
|
MP_UNARY_OP_ABS, // __abs__
|
2018-08-29 15:59:36 +01:00
|
|
|
MP_UNARY_OP_INT, // __int__
|
2017-08-11 07:42:39 +01:00
|
|
|
MP_UNARY_OP_SIZEOF, // for sys.getsizeof()
|
2017-10-03 13:34:28 +01:00
|
|
|
|
|
|
|
MP_UNARY_OP_NUM_RUNTIME,
|
2014-03-30 13:35:08 +01:00
|
|
|
} mp_unary_op_t;
|
2013-12-21 18:17:45 +00:00
|
|
|
|
2017-10-03 13:34:28 +01:00
|
|
|
// Note: the first 9+12+12 of these are used in bytecode and changing
|
2017-09-22 02:54:08 +01:00
|
|
|
// them requires changing the bytecode version.
|
2013-12-21 18:17:45 +00:00
|
|
|
typedef enum {
|
2019-07-25 03:10:45 +01:00
|
|
|
// 9 relational operations, should return a bool; order of first 6 matches corresponding mp_token_kind_t
|
2017-09-07 08:55:43 +01:00
|
|
|
MP_BINARY_OP_LESS,
|
|
|
|
MP_BINARY_OP_MORE,
|
|
|
|
MP_BINARY_OP_EQUAL,
|
|
|
|
MP_BINARY_OP_LESS_EQUAL,
|
|
|
|
MP_BINARY_OP_MORE_EQUAL,
|
|
|
|
MP_BINARY_OP_NOT_EQUAL,
|
|
|
|
MP_BINARY_OP_IN,
|
|
|
|
MP_BINARY_OP_IS,
|
|
|
|
MP_BINARY_OP_EXCEPTION_MATCH,
|
|
|
|
|
2019-07-25 04:15:54 +01:00
|
|
|
// 13 inplace arithmetic operations; order matches corresponding mp_token_kind_t
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_BINARY_OP_INPLACE_OR,
|
|
|
|
MP_BINARY_OP_INPLACE_XOR,
|
2015-06-13 22:00:10 +01:00
|
|
|
MP_BINARY_OP_INPLACE_AND,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_BINARY_OP_INPLACE_LSHIFT,
|
|
|
|
MP_BINARY_OP_INPLACE_RSHIFT,
|
|
|
|
MP_BINARY_OP_INPLACE_ADD,
|
2017-09-07 11:37:33 +01:00
|
|
|
MP_BINARY_OP_INPLACE_SUBTRACT,
|
2015-06-13 22:00:10 +01:00
|
|
|
MP_BINARY_OP_INPLACE_MULTIPLY,
|
2019-07-25 04:15:54 +01:00
|
|
|
MP_BINARY_OP_INPLACE_MAT_MULTIPLY,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_BINARY_OP_INPLACE_FLOOR_DIVIDE,
|
|
|
|
MP_BINARY_OP_INPLACE_TRUE_DIVIDE,
|
|
|
|
MP_BINARY_OP_INPLACE_MODULO,
|
|
|
|
MP_BINARY_OP_INPLACE_POWER,
|
2017-09-07 09:26:42 +01:00
|
|
|
|
2019-07-25 04:15:54 +01:00
|
|
|
// 13 normal arithmetic operations; order matches corresponding mp_token_kind_t
|
2017-09-07 22:10:10 +01:00
|
|
|
MP_BINARY_OP_OR,
|
|
|
|
MP_BINARY_OP_XOR,
|
|
|
|
MP_BINARY_OP_AND,
|
|
|
|
MP_BINARY_OP_LSHIFT,
|
|
|
|
MP_BINARY_OP_RSHIFT,
|
|
|
|
MP_BINARY_OP_ADD,
|
|
|
|
MP_BINARY_OP_SUBTRACT,
|
|
|
|
MP_BINARY_OP_MULTIPLY,
|
2019-07-25 04:15:54 +01:00
|
|
|
MP_BINARY_OP_MAT_MULTIPLY,
|
2017-09-07 22:10:10 +01:00
|
|
|
MP_BINARY_OP_FLOOR_DIVIDE,
|
|
|
|
MP_BINARY_OP_TRUE_DIVIDE,
|
|
|
|
MP_BINARY_OP_MODULO,
|
|
|
|
MP_BINARY_OP_POWER,
|
|
|
|
|
2017-09-07 09:26:42 +01:00
|
|
|
// Operations below this line don't appear in bytecode, they
|
|
|
|
// just identify special methods.
|
2017-10-03 13:34:28 +01:00
|
|
|
MP_BINARY_OP_NUM_BYTECODE,
|
2017-09-07 09:26:42 +01:00
|
|
|
|
2017-09-10 15:05:20 +01:00
|
|
|
// MP_BINARY_OP_REVERSE_* must follow immediately after MP_BINARY_OP_*
|
|
|
|
#if MICROPY_PY_REVERSE_SPECIAL_METHODS
|
2017-10-03 13:34:28 +01:00
|
|
|
MP_BINARY_OP_REVERSE_OR = MP_BINARY_OP_NUM_BYTECODE,
|
2017-09-10 15:05:20 +01:00
|
|
|
MP_BINARY_OP_REVERSE_XOR,
|
|
|
|
MP_BINARY_OP_REVERSE_AND,
|
|
|
|
MP_BINARY_OP_REVERSE_LSHIFT,
|
|
|
|
MP_BINARY_OP_REVERSE_RSHIFT,
|
|
|
|
MP_BINARY_OP_REVERSE_ADD,
|
|
|
|
MP_BINARY_OP_REVERSE_SUBTRACT,
|
|
|
|
MP_BINARY_OP_REVERSE_MULTIPLY,
|
2019-07-25 04:15:54 +01:00
|
|
|
MP_BINARY_OP_REVERSE_MAT_MULTIPLY,
|
2017-09-10 15:05:20 +01:00
|
|
|
MP_BINARY_OP_REVERSE_FLOOR_DIVIDE,
|
|
|
|
MP_BINARY_OP_REVERSE_TRUE_DIVIDE,
|
|
|
|
MP_BINARY_OP_REVERSE_MODULO,
|
|
|
|
MP_BINARY_OP_REVERSE_POWER,
|
|
|
|
#endif
|
|
|
|
|
2017-10-03 13:34:28 +01:00
|
|
|
// This is not emitted by the compiler but is supported by the runtime
|
|
|
|
MP_BINARY_OP_DIVMOD
|
|
|
|
#if !MICROPY_PY_REVERSE_SPECIAL_METHODS
|
|
|
|
= MP_BINARY_OP_NUM_BYTECODE
|
|
|
|
#endif
|
|
|
|
,
|
|
|
|
|
2017-11-24 02:04:24 +00:00
|
|
|
// The runtime will convert MP_BINARY_OP_IN to this operator with swapped args.
|
|
|
|
// A type should implement this containment operator instead of MP_BINARY_OP_IN.
|
|
|
|
MP_BINARY_OP_CONTAINS,
|
|
|
|
|
2017-10-03 13:34:28 +01:00
|
|
|
MP_BINARY_OP_NUM_RUNTIME,
|
2017-09-07 10:54:58 +01:00
|
|
|
|
2017-10-03 13:34:28 +01:00
|
|
|
// These 2 are not supported by the runtime and must be synthesised by the emitter
|
|
|
|
MP_BINARY_OP_NOT_IN,
|
|
|
|
MP_BINARY_OP_IS_NOT,
|
2014-03-30 13:35:08 +01:00
|
|
|
} mp_binary_op_t;
|
2013-12-21 18:17:45 +00:00
|
|
|
|
|
|
|
typedef enum {
|
2018-10-14 13:56:46 +01:00
|
|
|
MP_F_CONST_NONE_OBJ = 0,
|
|
|
|
MP_F_CONST_FALSE_OBJ,
|
|
|
|
MP_F_CONST_TRUE_OBJ,
|
|
|
|
MP_F_CONVERT_OBJ_TO_NATIVE,
|
2014-08-15 23:47:59 +01:00
|
|
|
MP_F_CONVERT_NATIVE_TO_OBJ,
|
py: Fix native functions so they run with their correct globals context.
Prior to this commit a function compiled with the native decorator
@micropython.native would not work correctly when accessing global
variables, because the globals dict was not being set upon function entry.
This commit fixes this problem by, upon function entry, setting as the
current globals dict the globals dict context the function was defined
within, as per normal Python semantics, and as bytecode does. Upon
function exit the original globals dict is restored.
In order to restore the globals dict when an exception is raised the native
function must guard its internals with an nlr_push/nlr_pop pair. Because
this push/pop is relatively expensive, in both C stack usage for the
nlr_buf_t and CPU execution time, the implementation here optimises things
as much as possible. First, the compiler keeps track of whether a function
even needs to access global variables. Using this information the native
emitter then generates three different kinds of code:
1. no globals used, no exception handlers: no nlr handling code and no
setting of the globals dict.
2. globals used, no exception handlers: an nlr_buf_t is allocated on the
C stack but it is not used if the globals dict is unchanged, saving
execution time because nlr_push/nlr_pop don't need to run.
3. function has exception handlers, may use globals: an nlr_buf_t is
allocated and nlr_push/nlr_pop are always called.
In the end, native functions that don't access globals and don't have
exception handlers will run more efficiently than those that do.
Fixes issue #1573.
2018-09-13 13:03:48 +01:00
|
|
|
MP_F_NATIVE_SWAP_GLOBALS,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_LOAD_NAME,
|
|
|
|
MP_F_LOAD_GLOBAL,
|
|
|
|
MP_F_LOAD_BUILD_CLASS,
|
|
|
|
MP_F_LOAD_ATTR,
|
|
|
|
MP_F_LOAD_METHOD,
|
2017-04-19 00:45:59 +01:00
|
|
|
MP_F_LOAD_SUPER_METHOD,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_STORE_NAME,
|
2014-08-15 23:47:59 +01:00
|
|
|
MP_F_STORE_GLOBAL,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_STORE_ATTR,
|
2014-04-17 22:10:53 +01:00
|
|
|
MP_F_OBJ_SUBSCR,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_OBJ_IS_TRUE,
|
|
|
|
MP_F_UNARY_OP,
|
|
|
|
MP_F_BINARY_OP,
|
|
|
|
MP_F_BUILD_TUPLE,
|
|
|
|
MP_F_BUILD_LIST,
|
|
|
|
MP_F_BUILD_MAP,
|
2018-05-22 13:18:42 +01:00
|
|
|
MP_F_BUILD_SET,
|
2019-09-02 11:24:01 +01:00
|
|
|
MP_F_STORE_SET,
|
|
|
|
MP_F_LIST_APPEND,
|
|
|
|
MP_F_STORE_MAP,
|
2014-04-13 11:04:33 +01:00
|
|
|
MP_F_MAKE_FUNCTION_FROM_RAW_CODE,
|
2014-08-16 22:06:11 +01:00
|
|
|
MP_F_NATIVE_CALL_FUNCTION_N_KW,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_CALL_METHOD_N_KW,
|
2015-04-06 22:48:21 +01:00
|
|
|
MP_F_CALL_METHOD_N_KW_VAR,
|
2017-01-17 04:27:37 +00:00
|
|
|
MP_F_NATIVE_GETITER,
|
|
|
|
MP_F_NATIVE_ITERNEXT,
|
2014-08-16 22:31:57 +01:00
|
|
|
MP_F_NLR_PUSH,
|
|
|
|
MP_F_NLR_POP,
|
2014-08-16 22:06:11 +01:00
|
|
|
MP_F_NATIVE_RAISE,
|
2014-04-06 12:58:40 +01:00
|
|
|
MP_F_IMPORT_NAME,
|
2014-08-16 22:31:57 +01:00
|
|
|
MP_F_IMPORT_FROM,
|
2014-04-06 12:58:40 +01:00
|
|
|
MP_F_IMPORT_ALL,
|
|
|
|
MP_F_NEW_SLICE,
|
|
|
|
MP_F_UNPACK_SEQUENCE,
|
2014-05-07 18:30:52 +01:00
|
|
|
MP_F_UNPACK_EX,
|
2014-09-06 18:38:20 +01:00
|
|
|
MP_F_DELETE_NAME,
|
|
|
|
MP_F_DELETE_GLOBAL,
|
2015-01-15 14:41:41 +00:00
|
|
|
MP_F_NEW_CELL,
|
|
|
|
MP_F_MAKE_CLOSURE_FROM_RAW_CODE,
|
2018-09-14 08:40:59 +01:00
|
|
|
MP_F_ARG_CHECK_NUM_SIG,
|
2015-04-06 22:38:53 +01:00
|
|
|
MP_F_SETUP_CODE_STATE,
|
2017-10-11 08:54:34 +01:00
|
|
|
MP_F_SMALL_INT_FLOOR_DIVIDE,
|
|
|
|
MP_F_SMALL_INT_MODULO,
|
2018-10-01 04:07:04 +01:00
|
|
|
MP_F_NATIVE_YIELD_FROM,
|
2019-09-10 04:44:22 +01:00
|
|
|
MP_F_SETJMP,
|
2014-03-30 13:35:08 +01:00
|
|
|
MP_F_NUMBER_OF,
|
|
|
|
} mp_fun_kind_t;
|
2013-12-21 18:17:45 +00:00
|
|
|
|
2018-10-14 13:56:46 +01:00
|
|
|
extern const void *const mp_fun_table[MP_F_NUMBER_OF];
|
2014-12-25 21:29:19 +00:00
|
|
|
|
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_RUNTIME0_H
|