blob: 6396850b38e7099b15a500284b8ee459fe136cee [file] [log] [blame]
Damien George04b91472014-05-03 23:27:38 +01001/*
Damien Georgec408ed92017-06-26 12:29:20 +10002 * This file is part of the MicroPython project, http://micropython.org/
Damien George04b91472014-05-03 23:27:38 +01003 *
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 */
Alexander Steffen299bc622017-06-29 23:14:58 +020026#ifndef MICROPY_INCLUDED_PY_MPCONFIG_H
27#define MICROPY_INCLUDED_PY_MPCONFIG_H
Damien George04b91472014-05-03 23:27:38 +010028
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020029// This file contains default configuration settings for MicroPython.
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020030// You can override any of the options below using mpconfigport.h file
31// located in a directory of your port.
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020032
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020033// mpconfigport.h is a file containing configuration settings for a
34// particular port. mpconfigport.h is actually a default name for
Ville Skyttäca16c382017-05-29 10:08:14 +030035// such config, and it can be overridden using MP_CONFIGFILE preprocessor
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020036// define (you can do that by passing CFLAGS_EXTRA='-DMP_CONFIGFILE="<file.h>"'
37// argument to make when using standard MicroPython makefiles).
38// This is useful to have more than one config per port, for example,
39// release vs debug configs, etc. Note that if you switch from one config
40// to another, you must rebuild from scratch using "-B" switch to make.
41
42#ifdef MP_CONFIGFILE
43#include MP_CONFIGFILE
44#else
Damien George8340c482014-06-12 19:50:17 +010045#include <mpconfigport.h>
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020046#endif
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020047
Damien George136f6752014-01-07 14:54:15 +000048// Any options not explicitly set in mpconfigport.h will get default
49// values below.
50
51/*****************************************************************************/
Damien George567184e2015-03-29 14:05:46 +010052/* Object representation */
53
Damien Georgec408ed92017-06-26 12:29:20 +100054// A MicroPython object is a machine word having the following form:
Damien George567184e2015-03-29 14:05:46 +010055// - xxxx...xxx1 : a small int, bits 1 and above are the value
56// - xxxx...xx10 : a qstr, bits 2 and above are the value
57// - xxxx...xx00 : a pointer to an mp_obj_base_t (unless a fake object)
58#define MICROPY_OBJ_REPR_A (0)
59
Damien Georgec408ed92017-06-26 12:29:20 +100060// A MicroPython object is a machine word having the following form:
Damien George567184e2015-03-29 14:05:46 +010061// - xxxx...xx01 : a small int, bits 2 and above are the value
62// - xxxx...xx11 : a qstr, bits 2 and above are the value
63// - xxxx...xxx0 : a pointer to an mp_obj_base_t (unless a fake object)
64#define MICROPY_OBJ_REPR_B (1)
65
Damien George8b8d1892015-11-06 23:25:10 +000066// A MicroPython object is a machine word having the following form (called R):
Damien George183edef2015-10-17 23:20:57 +010067// - iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int with 31-bit signed value
Damien George8b8d1892015-11-06 23:25:10 +000068// - 01111111 1qqqqqqq qqqqqqqq qqqqq110 str with 20-bit qstr value
Damien George183edef2015-10-17 23:20:57 +010069// - s1111111 10000000 00000000 00000010 +/- inf
70// - s1111111 1xxxxxxx xxxxxxxx xxxxx010 nan, x != 0
71// - seeeeeee efffffff ffffffff ffffff10 30-bit fp, e != 0xff
72// - pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
Damien George8b8d1892015-11-06 23:25:10 +000073// Str and float stored as O = R + 0x80800000, retrieved as R = O - 0x80800000.
74// This makes strs easier to encode/decode as they have zeros in the top 9 bits.
Damien George183edef2015-10-17 23:20:57 +010075// This scheme only works with 32-bit word size and float enabled.
76#define MICROPY_OBJ_REPR_C (2)
77
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000078// A MicroPython object is a 64-bit word having the following form (called R):
79// - seeeeeee eeeeffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff 64-bit fp, e != 0x7ff
80// - s1111111 11110000 00000000 00000000 00000000 00000000 00000000 00000000 +/- inf
81// - 01111111 11111000 00000000 00000000 00000000 00000000 00000000 00000000 normalised nan
Damien George2759bec2017-12-11 22:39:12 +110082// - 01111111 11111101 iiiiiiii iiiiiiii iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000083// - 01111111 11111110 00000000 00000000 qqqqqqqq qqqqqqqq qqqqqqqq qqqqqqq1 str
84// - 01111111 11111100 00000000 00000000 pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
85// Stored as O = R + 0x8004000000000000, retrieved as R = O - 0x8004000000000000.
86// This makes pointers have all zeros in the top 32 bits.
87// Small-ints and strs have 1 as LSB to make sure they don't look like pointers
88// to the garbage collector.
89#define MICROPY_OBJ_REPR_D (3)
90
Damien George567184e2015-03-29 14:05:46 +010091#ifndef MICROPY_OBJ_REPR
92#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
93#endif
94
95/*****************************************************************************/
Damien George66e18f02014-05-05 13:19:03 +010096/* Memory allocation policy */
97
Paul Sokolovsky75feece2015-12-03 01:40:52 +020098// Number of bytes in memory allocation/GC block. Any size allocated will be
99// rounded up to be multiples of this.
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200100#ifndef MICROPY_BYTES_PER_GC_BLOCK
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200101#define MICROPY_BYTES_PER_GC_BLOCK (4 * BYTES_PER_WORD)
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200102#endif
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200103
Damien Georgefd40a9c2015-01-01 22:04:46 +0000104// Number of words allocated (in BSS) to the GC stack (minimum is 1)
105#ifndef MICROPY_ALLOC_GC_STACK_SIZE
106#define MICROPY_ALLOC_GC_STACK_SIZE (64)
107#endif
108
Damien George5ffe1d82016-08-26 15:35:26 +1000109// Be conservative and always clear to zero newly (re)allocated memory in the GC.
110// This helps eliminate stray pointers that hold on to memory that's no longer
111// used. It decreases performance due to unnecessary memory clearing.
Colin Hogben828df542016-10-31 14:52:11 +0000112// A memory manager which always clears memory can set this to 0.
Damien George5ffe1d82016-08-26 15:35:26 +1000113// TODO Do analysis to understand why some memory is not properly cleared and
114// find a more efficient way to clear it.
115#ifndef MICROPY_GC_CONSERVATIVE_CLEAR
Colin Hogben828df542016-10-31 14:52:11 +0000116#define MICROPY_GC_CONSERVATIVE_CLEAR (MICROPY_ENABLE_GC)
Damien George5ffe1d82016-08-26 15:35:26 +1000117#endif
118
Paul Sokolovsky93e353e2016-07-21 00:37:30 +0300119// Support automatic GC when reaching allocation threshold,
120// configurable by gc.threshold().
121#ifndef MICROPY_GC_ALLOC_THRESHOLD
122#define MICROPY_GC_ALLOC_THRESHOLD (1)
123#endif
124
Damien Georgeade9a052015-06-13 21:53:22 +0100125// Number of bytes to allocate initially when creating new chunks to store
126// interned string data. Smaller numbers lead to more chunks being needed
127// and more wastage at the end of the chunk. Larger numbers lead to wasted
128// space at the end when no more strings need interning.
129#ifndef MICROPY_ALLOC_QSTR_CHUNK_INIT
130#define MICROPY_ALLOC_QSTR_CHUNK_INIT (128)
131#endif
132
Damien Georgee1199ec2014-05-10 17:48:01 +0100133// Initial amount for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100134#ifndef MICROPY_ALLOC_LEXER_INDENT_INIT
135#define MICROPY_ALLOC_LEXER_INDENT_INIT (10)
Damien Georgee1199ec2014-05-10 17:48:01 +0100136#endif
137
138// Increment for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100139#ifndef MICROPY_ALLOC_LEXEL_INDENT_INC
140#define MICROPY_ALLOC_LEXEL_INDENT_INC (8)
Damien Georgee1199ec2014-05-10 17:48:01 +0100141#endif
142
Damien George66e18f02014-05-05 13:19:03 +0100143// Initial amount for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100144#ifndef MICROPY_ALLOC_PARSE_RULE_INIT
145#define MICROPY_ALLOC_PARSE_RULE_INIT (64)
Damien George66e18f02014-05-05 13:19:03 +0100146#endif
147
148// Increment for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100149#ifndef MICROPY_ALLOC_PARSE_RULE_INC
150#define MICROPY_ALLOC_PARSE_RULE_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100151#endif
152
153// Initial amount for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100154#ifndef MICROPY_ALLOC_PARSE_RESULT_INIT
155#define MICROPY_ALLOC_PARSE_RESULT_INIT (32)
Damien George66e18f02014-05-05 13:19:03 +0100156#endif
157
158// Increment for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100159#ifndef MICROPY_ALLOC_PARSE_RESULT_INC
160#define MICROPY_ALLOC_PARSE_RESULT_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100161#endif
162
Damien George5042bce2014-05-25 22:06:06 +0100163// Strings this length or less will be interned by the parser
164#ifndef MICROPY_ALLOC_PARSE_INTERN_STRING_LEN
165#define MICROPY_ALLOC_PARSE_INTERN_STRING_LEN (10)
166#endif
167
Damien George58e0f4a2015-09-23 10:50:43 +0100168// Number of bytes to allocate initially when creating new chunks to store
169// parse nodes. Small leads to fragmentation, large leads to excess use.
170#ifndef MICROPY_ALLOC_PARSE_CHUNK_INIT
171#define MICROPY_ALLOC_PARSE_CHUNK_INIT (128)
172#endif
173
Damien George66e18f02014-05-05 13:19:03 +0100174// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100175#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
176#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100177#endif
178
179// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100180#ifndef MICROPY_ALLOC_SCOPE_ID_INC
181#define MICROPY_ALLOC_SCOPE_ID_INC (6)
182#endif
183
184// Maximum length of a path in the filesystem
185// So we can allocate a buffer on the stack for path manipulation in import
186#ifndef MICROPY_ALLOC_PATH_MAX
187#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100188#endif
189
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200190// Initial size of module dict
191#ifndef MICROPY_MODULE_DICT_SIZE
192#define MICROPY_MODULE_DICT_SIZE (1)
193#endif
194
Damien Georged8914522015-02-27 09:54:12 +0000195// Whether realloc/free should be passed allocated memory region size
196// You must enable this if MICROPY_MEM_STATS is enabled
197#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
198#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
199#endif
200
Damien George95836f82015-01-11 22:27:30 +0000201// Number of bytes used to store qstr length
202// Dictates hard limit on maximum Python identifier length, but 1 byte
203// (limit of 255 bytes in an identifier) should be enough for everyone
204#ifndef MICROPY_QSTR_BYTES_IN_LEN
205#define MICROPY_QSTR_BYTES_IN_LEN (1)
206#endif
207
Damien Georgec3bd9412015-07-20 11:03:13 +0000208// Number of bytes used to store qstr hash
209#ifndef MICROPY_QSTR_BYTES_IN_HASH
210#define MICROPY_QSTR_BYTES_IN_HASH (2)
211#endif
212
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200213// Avoid using C stack when making Python function calls. C stack still
214// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200215#ifndef MICROPY_STACKLESS
216#define MICROPY_STACKLESS (0)
217#endif
218
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200219// Never use C stack when making Python function calls. This may break
220// testsuite as will subtly change which exception is thrown in case
221// of too deep recursion and other similar cases.
222#ifndef MICROPY_STACKLESS_STRICT
223#define MICROPY_STACKLESS_STRICT (0)
224#endif
225
Paul Sokolovskyf32020e2015-11-25 23:22:31 +0200226// Don't use alloca calls. As alloca() is not part of ANSI C, this
227// workaround option is provided for compilers lacking this de-facto
228// standard function. The way it works is allocating from heap, and
229// relying on garbage collection to free it eventually. This is of
230// course much less optimal than real alloca().
231#if defined(MICROPY_NO_ALLOCA) && MICROPY_NO_ALLOCA
232#undef alloca
233#define alloca(x) m_malloc(x)
234#endif
235
Damien George66e18f02014-05-05 13:19:03 +0100236/*****************************************************************************/
Damien Georgec408ed92017-06-26 12:29:20 +1000237/* MicroPython emitters */
Damien George136f6752014-01-07 14:54:15 +0000238
Damien Georged8c834c2015-11-02 21:55:42 +0000239// Whether to support loading of persistent code
240#ifndef MICROPY_PERSISTENT_CODE_LOAD
241#define MICROPY_PERSISTENT_CODE_LOAD (0)
242#endif
243
244// Whether to support saving of persistent code
245#ifndef MICROPY_PERSISTENT_CODE_SAVE
246#define MICROPY_PERSISTENT_CODE_SAVE (0)
247#endif
248
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000249// Whether generated code can persist independently of the VM/runtime instance
Damien Georged8c834c2015-11-02 21:55:42 +0000250// This is enabled automatically when needed by other features
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000251#ifndef MICROPY_PERSISTENT_CODE
Damien George0a2e9652016-01-31 22:24:16 +0000252#define MICROPY_PERSISTENT_CODE (MICROPY_PERSISTENT_CODE_LOAD || MICROPY_PERSISTENT_CODE_SAVE || MICROPY_MODULE_FROZEN_MPY)
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000253#endif
254
Damien George136f6752014-01-07 14:54:15 +0000255// Whether to emit x64 native code
256#ifndef MICROPY_EMIT_X64
257#define MICROPY_EMIT_X64 (0)
258#endif
259
Damien Georgec90f59e2014-09-06 23:06:36 +0100260// Whether to emit x86 native code
261#ifndef MICROPY_EMIT_X86
262#define MICROPY_EMIT_X86 (0)
263#endif
264
Damien George136f6752014-01-07 14:54:15 +0000265// Whether to emit thumb native code
266#ifndef MICROPY_EMIT_THUMB
267#define MICROPY_EMIT_THUMB (0)
268#endif
269
270// Whether to enable the thumb inline assembler
271#ifndef MICROPY_EMIT_INLINE_THUMB
272#define MICROPY_EMIT_INLINE_THUMB (0)
273#endif
274
Damien Georgee8135412015-10-16 22:08:57 +0100275// Whether to enable ARMv7-M instruction support in the Thumb2 inline assembler
276#ifndef MICROPY_EMIT_INLINE_THUMB_ARMV7M
277#define MICROPY_EMIT_INLINE_THUMB_ARMV7M (1)
278#endif
279
=50089722015-04-14 13:14:57 +0100280// Whether to enable float support in the Thumb2 inline assembler
281#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
282#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
283#endif
284
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200285// Whether to emit ARM native code
286#ifndef MICROPY_EMIT_ARM
287#define MICROPY_EMIT_ARM (0)
288#endif
289
Damien George8e5aced2016-12-09 16:39:39 +1100290// Whether to emit Xtensa native code
291#ifndef MICROPY_EMIT_XTENSA
292#define MICROPY_EMIT_XTENSA (0)
293#endif
294
Damien Georgef76b1bf2016-12-09 17:03:33 +1100295// Whether to enable the Xtensa inline assembler
296#ifndef MICROPY_EMIT_INLINE_XTENSA
297#define MICROPY_EMIT_INLINE_XTENSA (0)
298#endif
299
Damien George2ac4af62014-08-15 16:45:41 +0100300// Convenience definition for whether any native emitter is enabled
Damien George8e5aced2016-12-09 16:39:39 +1100301#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM || MICROPY_EMIT_XTENSA)
Damien George2ac4af62014-08-15 16:45:41 +0100302
Damien Georgead297a12016-12-09 13:17:49 +1100303// Convenience definition for whether any inline assembler emitter is enabled
Damien Georgef76b1bf2016-12-09 17:03:33 +1100304#define MICROPY_EMIT_INLINE_ASM (MICROPY_EMIT_INLINE_THUMB || MICROPY_EMIT_INLINE_XTENSA)
Damien Georgead297a12016-12-09 13:17:49 +1100305
Damien George136f6752014-01-07 14:54:15 +0000306/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100307/* Compiler configuration */
308
Damien Georgedd5353a2015-12-18 12:35:44 +0000309// Whether to include the compiler
310#ifndef MICROPY_ENABLE_COMPILER
311#define MICROPY_ENABLE_COMPILER (1)
312#endif
313
Damien Georgeea235202016-02-11 22:30:53 +0000314// Whether the compiler is dynamically configurable (ie at runtime)
315#ifndef MICROPY_DYNAMIC_COMPILER
316#define MICROPY_DYNAMIC_COMPILER (0)
317#endif
318
319// Configure dynamic compiler macros
320#if MICROPY_DYNAMIC_COMPILER
321#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE_DYNAMIC (mp_dynamic_compiler.opt_cache_map_lookup_in_bytecode)
322#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC (mp_dynamic_compiler.py_builtins_str_unicode)
323#else
324#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE_DYNAMIC MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
325#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC MICROPY_PY_BUILTINS_STR_UNICODE
326#endif
327
Damien George64f2b212015-10-08 14:58:15 +0100328// Whether to enable constant folding; eg 1+2 rewritten as 3
329#ifndef MICROPY_COMP_CONST_FOLDING
330#define MICROPY_COMP_CONST_FOLDING (1)
331#endif
332
Damien Georgeddd1e182015-01-10 14:07:24 +0000333// Whether to enable lookup of constants in modules; eg module.CONST
334#ifndef MICROPY_COMP_MODULE_CONST
335#define MICROPY_COMP_MODULE_CONST (0)
336#endif
337
Damien George58ebde42014-05-21 20:32:59 +0100338// Whether to enable constant optimisation; id = const(value)
339#ifndef MICROPY_COMP_CONST
340#define MICROPY_COMP_CONST (1)
341#endif
342
Damien George42e0c592015-03-14 13:11:35 +0000343// Whether to enable optimisation of: a, b = c, d
344// Costs 124 bytes (Thumb2)
345#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
346#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
347#endif
348
349// Whether to enable optimisation of: a, b, c = d, e, f
Damien George253f2bd2018-02-04 13:35:21 +1100350// Requires MICROPY_COMP_DOUBLE_TUPLE_ASSIGN and costs 68 bytes (Thumb2)
Damien George42e0c592015-03-14 13:11:35 +0000351#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
352#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
353#endif
354
Damien Georgeae54fbf2017-04-22 14:58:01 +1000355// Whether to enable optimisation of: return a if b else c
356// Costs about 80 bytes (Thumb2) and saves 2 bytes of bytecode for each use
357#ifndef MICROPY_COMP_RETURN_IF_EXPR
358#define MICROPY_COMP_RETURN_IF_EXPR (0)
359#endif
360
Damien George58ebde42014-05-21 20:32:59 +0100361/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000362/* Internal debugging stuff */
363
364// Whether to collect memory allocation stats
365#ifndef MICROPY_MEM_STATS
366#define MICROPY_MEM_STATS (0)
367#endif
368
Damien Georgeda2d2b62018-08-02 14:04:44 +1000369// The mp_print_t printer used for debugging output
370#ifndef MICROPY_DEBUG_PRINTER
371#define MICROPY_DEBUG_PRINTER (&mp_plat_print)
372#endif
373
Damien Georgecbd2f742014-01-19 11:48:48 +0000374// Whether to build functions that print debugging info:
Damien George3417bc22014-05-10 10:36:38 +0100375// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000376// mp_parse_node_print
377#ifndef MICROPY_DEBUG_PRINTERS
378#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000379#endif
380
Stefan Naumannace9fb52017-07-24 18:55:14 +0200381// Whether to enable all debugging outputs (it will be extremely verbose)
382#ifndef MICROPY_DEBUG_VERBOSE
383#define MICROPY_DEBUG_VERBOSE (0)
384#endif
385
Damien George136f6752014-01-07 14:54:15 +0000386/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100387/* Optimisations */
388
389// Whether to use computed gotos in the VM, or a switch
390// Computed gotos are roughly 10% faster, and increase VM code size by a little
Damien George44f0a4d2017-09-18 23:53:33 +1000391// Note: enabling this will use the gcc-specific extensions of ranged designated
392// initialisers and addresses of labels, which are not part of the C99 standard.
Damien Georgeee3fd462014-05-24 23:03:12 +0100393#ifndef MICROPY_OPT_COMPUTED_GOTO
394#define MICROPY_OPT_COMPUTED_GOTO (0)
395#endif
396
Damien George7ee91cf2015-01-06 12:51:39 +0000397// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
398// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
399// uses a bit of extra code ROM, but greatly improves lookup speed.
400#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
401#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
402#endif
403
Doug Currie2e2e15c2016-01-30 22:35:58 -0500404// Whether to use fast versions of bitwise operations (and, or, xor) when the
405// arguments are both positive. Increases Thumb2 code size by about 250 bytes.
406#ifndef MICROPY_OPT_MPZ_BITWISE
407#define MICROPY_OPT_MPZ_BITWISE (0)
408#endif
409
Damien Georgeee3fd462014-05-24 23:03:12 +0100410/*****************************************************************************/
411/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000412
Damien George20993682018-02-20 18:00:44 +1100413// Whether to enable import of external modules
414// When disabled, only importing of built-in modules is supported
415// When enabled, a port must implement mp_import_stat (among other things)
416#ifndef MICROPY_ENABLE_EXTERNAL_IMPORT
417#define MICROPY_ENABLE_EXTERNAL_IMPORT (1)
418#endif
419
Damien George6b239c22016-11-16 16:04:57 +1100420// Whether to use the POSIX reader for importing files
421#ifndef MICROPY_READER_POSIX
422#define MICROPY_READER_POSIX (0)
423#endif
424
Damien Georgedcb9ea72017-01-27 15:10:09 +1100425// Whether to use the VFS reader for importing files
426#ifndef MICROPY_READER_VFS
427#define MICROPY_READER_VFS (0)
428#endif
429
Damien George40d84302016-02-15 22:46:21 +0000430// Hook for the VM at the start of the opcode loop (can contain variable
431// definitions usable by the other hook functions)
432#ifndef MICROPY_VM_HOOK_INIT
433#define MICROPY_VM_HOOK_INIT
434#endif
435
436// Hook for the VM during the opcode loop (but only after jump opcodes)
437#ifndef MICROPY_VM_HOOK_LOOP
438#define MICROPY_VM_HOOK_LOOP
439#endif
440
441// Hook for the VM just before return opcode is finished being interpreted
442#ifndef MICROPY_VM_HOOK_RETURN
443#define MICROPY_VM_HOOK_RETURN
444#endif
445
Damien Georged3ebe482014-01-07 15:20:33 +0000446// Whether to include the garbage collector
447#ifndef MICROPY_ENABLE_GC
448#define MICROPY_ENABLE_GC (0)
449#endif
450
Damien George12bab722014-04-05 20:35:48 +0100451// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000452#ifndef MICROPY_ENABLE_FINALISER
453#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100454#endif
455
Damien George02d830c2017-11-26 23:28:40 +1100456// Whether to enable a separate allocator for the Python stack.
457// If enabled then the code must call mp_pystack_init before mp_init.
458#ifndef MICROPY_ENABLE_PYSTACK
459#define MICROPY_ENABLE_PYSTACK (0)
460#endif
461
462// Number of bytes that memory returned by mp_pystack_alloc will be aligned by.
463#ifndef MICROPY_PYSTACK_ALIGN
464#define MICROPY_PYSTACK_ALIGN (8)
465#endif
466
Paul Sokolovsky23668692014-06-25 03:03:34 +0300467// Whether to check C stack usage. C stack used for calling Python functions,
468// etc. Not checking means segfault on overflow.
469#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000470#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300471#endif
472
Dave Hylands5b7fd202014-07-01 23:46:53 -0700473// Whether to have an emergency exception buffer
474#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
475#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
476#endif
477#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
478# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
479# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
480# endif
481#endif
482
Damien Georgebbb4b982017-04-10 17:19:36 +1000483// Whether to provide the mp_kbd_exception object, and micropython.kbd_intr function
Damien George7f1da0a2016-12-15 13:00:19 +1100484#ifndef MICROPY_KBD_EXCEPTION
485#define MICROPY_KBD_EXCEPTION (0)
486#endif
487
Paul Sokolovsky1c9210b2015-12-23 00:06:37 +0200488// Prefer to raise KeyboardInterrupt asynchronously (from signal or interrupt
489// handler) - if supported by a particular port.
490#ifndef MICROPY_ASYNC_KBD_INTR
491#define MICROPY_ASYNC_KBD_INTR (0)
492#endif
493
Damien George136f6752014-01-07 14:54:15 +0000494// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100495#ifndef MICROPY_HELPER_REPL
496#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000497#endif
498
Tom Soulanille7d588b02015-07-09 16:32:36 -0700499// Whether to include emacs-style readline behavior in REPL
500#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100501#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700502#endif
503
Damien George0af73012015-08-20 10:34:16 +0100504// Whether to implement auto-indent in REPL
505#ifndef MICROPY_REPL_AUTO_INDENT
506#define MICROPY_REPL_AUTO_INDENT (0)
507#endif
508
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200509// Whether port requires event-driven REPL functions
510#ifndef MICROPY_REPL_EVENT_DRIVEN
511#define MICROPY_REPL_EVENT_DRIVEN (0)
512#endif
513
Damien Georged3ebe482014-01-07 15:20:33 +0000514// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100515#ifndef MICROPY_HELPER_LEXER_UNIX
516#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000517#endif
518
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200519// Long int implementation
520#define MICROPY_LONGINT_IMPL_NONE (0)
521#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000522#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200523
524#ifndef MICROPY_LONGINT_IMPL
525#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
526#endif
527
528#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
529typedef long long mp_longint_impl_t;
530#endif
531
Damien George62ad1892014-01-29 21:51:51 +0000532// Whether to include information in the byte code to determine source
533// line number (increases RAM usage, but doesn't slow byte code execution)
534#ifndef MICROPY_ENABLE_SOURCE_LINE
535#define MICROPY_ENABLE_SOURCE_LINE (0)
536#endif
537
Damien George1463c1f2014-04-25 23:52:57 +0100538// Whether to include doc strings (increases RAM usage)
539#ifndef MICROPY_ENABLE_DOC_STRING
540#define MICROPY_ENABLE_DOC_STRING (0)
541#endif
542
Damien George1e9a92f2014-11-06 17:36:16 +0000543// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300544#define MICROPY_ERROR_REPORTING_TERSE (1)
545// Exception messages provide basic error details
546#define MICROPY_ERROR_REPORTING_NORMAL (2)
547// Exception messages provide full info, e.g. object names
548#define MICROPY_ERROR_REPORTING_DETAILED (3)
549
550#ifndef MICROPY_ERROR_REPORTING
551#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
552#endif
553
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200554// Whether issue warnings during compiling/execution
555#ifndef MICROPY_WARNINGS
556#define MICROPY_WARNINGS (0)
557#endif
558
David Lechner62849b72017-09-24 20:15:48 -0500559// This macro is used when printing runtime warnings and errors
560#ifndef MICROPY_ERROR_PRINTER
561#define MICROPY_ERROR_PRINTER (&mp_plat_print)
562#endif
563
Damien George0c36da02014-03-08 15:24:39 +0000564// Float and complex implementation
565#define MICROPY_FLOAT_IMPL_NONE (0)
566#define MICROPY_FLOAT_IMPL_FLOAT (1)
567#define MICROPY_FLOAT_IMPL_DOUBLE (2)
568
569#ifndef MICROPY_FLOAT_IMPL
570#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
571#endif
572
573#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100574#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100575#define MICROPY_FLOAT_CONST(x) x##F
Damien George0c36da02014-03-08 15:24:39 +0000576#define MICROPY_FLOAT_C_FUN(fun) fun##f
577typedef float mp_float_t;
578#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100579#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100580#define MICROPY_FLOAT_CONST(x) x
Damien George0c36da02014-03-08 15:24:39 +0000581#define MICROPY_FLOAT_C_FUN(fun) fun
582typedef double mp_float_t;
583#else
Damien Georgefb510b32014-06-01 13:32:54 +0100584#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000585#endif
586
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300587#ifndef MICROPY_PY_BUILTINS_COMPLEX
588#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
589#endif
590
Damien Georgea73501b2017-04-06 17:27:33 +1000591// Whether to provide a high-quality hash for float and complex numbers.
592// Otherwise the default is a very simple but correct hashing function.
593#ifndef MICROPY_FLOAT_HIGH_QUALITY_HASH
594#define MICROPY_FLOAT_HIGH_QUALITY_HASH (0)
595#endif
596
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200597// Enable features which improve CPython compatibility
598// but may lead to more code size/memory usage.
599// TODO: Originally intended as generic category to not
600// add bunch of once-off options. May need refactoring later
601#ifndef MICROPY_CPYTHON_COMPAT
602#define MICROPY_CPYTHON_COMPAT (1)
603#endif
604
Paul Sokolovsky9a973972017-04-02 21:20:07 +0300605// Perform full checks as done by CPython. Disabling this
606// may produce incorrect results, if incorrect data is fed,
607// but should not lead to MicroPython crashes or similar
608// grave issues (in other words, only user app should be,
609// affected, not system).
610#ifndef MICROPY_FULL_CHECKS
611#define MICROPY_FULL_CHECKS (1)
612#endif
613
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300614// Whether POSIX-semantics non-blocking streams are supported
615#ifndef MICROPY_STREAMS_NON_BLOCK
616#define MICROPY_STREAMS_NON_BLOCK (0)
617#endif
618
Paul Sokolovsky61e77a42016-07-30 20:05:56 +0300619// Whether to provide stream functions with POSIX-like signatures
620// (useful for porting existing libraries to MicroPython).
621#ifndef MICROPY_STREAMS_POSIX_API
622#define MICROPY_STREAMS_POSIX_API (0)
623#endif
624
Damien George3c9c3682015-09-15 14:56:13 +0100625// Whether to call __init__ when importing builtin modules for the first time
626#ifndef MICROPY_MODULE_BUILTIN_INIT
627#define MICROPY_MODULE_BUILTIN_INIT (0)
628#endif
629
Damien Georgec14a8162014-10-12 11:46:04 +0100630// Whether module weak links are supported
631#ifndef MICROPY_MODULE_WEAK_LINKS
632#define MICROPY_MODULE_WEAK_LINKS (0)
633#endif
634
Damien George0a2e9652016-01-31 22:24:16 +0000635// Whether frozen modules are supported in the form of strings
636#ifndef MICROPY_MODULE_FROZEN_STR
637#define MICROPY_MODULE_FROZEN_STR (0)
638#endif
639
640// Whether frozen modules are supported in the form of .mpy files
641#ifndef MICROPY_MODULE_FROZEN_MPY
642#define MICROPY_MODULE_FROZEN_MPY (0)
643#endif
644
645// Convenience macro for whether frozen modules are supported
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200646#ifndef MICROPY_MODULE_FROZEN
Damien George0a2e9652016-01-31 22:24:16 +0000647#define MICROPY_MODULE_FROZEN (MICROPY_MODULE_FROZEN_STR || MICROPY_MODULE_FROZEN_MPY)
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200648#endif
649
Damien George78d702c2014-12-09 16:19:48 +0000650// Whether you can override builtins in the builtins module
651#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
652#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
653#endif
654
Damien George06593fb2015-06-19 12:49:10 +0000655// Whether to check that the "self" argument of a builtin method has the
656// correct type. Such an explicit check is only needed if a builtin
657// method escapes to Python land without a first argument, eg
658// list.append([], 1). Without this check such calls will have undefined
659// behaviour (usually segfault) if the first argument is the wrong type.
660#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
661#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
662#endif
663
Damien George3f56fd62016-05-10 10:54:06 +0100664// Whether to use internally defined errno's (otherwise system provided ones)
665#ifndef MICROPY_USE_INTERNAL_ERRNO
666#define MICROPY_USE_INTERNAL_ERRNO (0)
667#endif
668
Delio Brignolie2ac8bb2016-08-21 11:33:37 +0200669// Whether to use internally defined *printf() functions (otherwise external ones)
670#ifndef MICROPY_USE_INTERNAL_PRINTF
671#define MICROPY_USE_INTERNAL_PRINTF (1)
672#endif
673
Damien George6e74d242017-02-16 18:05:06 +1100674// Support for internal scheduler
675#ifndef MICROPY_ENABLE_SCHEDULER
676#define MICROPY_ENABLE_SCHEDULER (0)
677#endif
678
679// Maximum number of entries in the scheduler
680#ifndef MICROPY_SCHEDULER_DEPTH
681#define MICROPY_SCHEDULER_DEPTH (4)
682#endif
683
Damien Georgedcb9ea72017-01-27 15:10:09 +1100684// Support for generic VFS sub-system
685#ifndef MICROPY_VFS
686#define MICROPY_VFS (0)
687#endif
688
Damien George8d82b0e2018-06-06 13:11:33 +1000689// Support for VFS POSIX component, to mount a POSIX filesystem within VFS
690#ifndef MICROPY_VFS
691#define MICROPY_VFS_POSIX (0)
692#endif
693
Damien Georgea8b9e712018-06-06 14:31:29 +1000694// Support for VFS FAT component, to mount a FAT filesystem within VFS
695#ifndef MICROPY_VFS
696#define MICROPY_VFS_FAT (0)
697#endif
698
Damien Georgeee3fd462014-05-24 23:03:12 +0100699/*****************************************************************************/
700/* Fine control over Python builtins, classes, modules, etc */
701
Damien Georgeda154fd2017-04-01 23:52:24 +1100702// Whether to support multiple inheritance of Python classes. Multiple
703// inheritance makes some C functions inherently recursive, and adds a bit of
704// code overhead.
705#ifndef MICROPY_MULTIPLE_INHERITANCE
706#define MICROPY_MULTIPLE_INHERITANCE (1)
707#endif
708
stijn3cc17c62015-02-14 18:44:31 +0100709// Whether to implement attributes on functions
710#ifndef MICROPY_PY_FUNCTION_ATTRS
711#define MICROPY_PY_FUNCTION_ATTRS (0)
712#endif
713
Damien George36c10522018-05-25 17:09:54 +1000714// Whether to support the descriptors __get__, __set__, __delete__
715// This costs some code size and makes load/store/delete of instance
716// attributes slower for the classes that use this feature
stijn28fa84b2015-02-14 18:43:54 +0100717#ifndef MICROPY_PY_DESCRIPTORS
718#define MICROPY_PY_DESCRIPTORS (0)
719#endif
720
dmazzella18e65692017-01-03 11:00:12 +0100721// Whether to support class __delattr__ and __setattr__ methods
Damien George36c10522018-05-25 17:09:54 +1000722// This costs some code size and makes store/delete of instance
723// attributes slower for the classes that use this feature
dmazzella18e65692017-01-03 11:00:12 +0100724#ifndef MICROPY_PY_DELATTR_SETATTR
725#define MICROPY_PY_DELATTR_SETATTR (0)
726#endif
727
pohmelie81ebba72016-01-27 23:23:11 +0300728// Support for async/await/async for/async with
729#ifndef MICROPY_PY_ASYNC_AWAIT
730#define MICROPY_PY_ASYNC_AWAIT (1)
731#endif
732
Paul Sokolovsky63644012017-10-21 12:13:44 +0300733// Non-standard .pend_throw() method for generators, allowing for
734// Future-like behavior with respect to exception handling: an
735// exception set with .pend_throw() will activate on the next call
736// to generator's .send() or .__next__(). (This is useful to implement
737// async schedulers.)
738#ifndef MICROPY_PY_GENERATOR_PEND_THROW
739#define MICROPY_PY_GENERATOR_PEND_THROW (1)
740#endif
741
Paul Sokolovskya1b442b2016-07-22 00:46:24 +0300742// Issue a warning when comparing str and bytes objects
Paul Sokolovsky707cae72016-07-22 00:34:34 +0300743#ifndef MICROPY_PY_STR_BYTES_CMP_WARN
744#define MICROPY_PY_STR_BYTES_CMP_WARN (0)
745#endif
746
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300747// Whether str object is proper unicode
748#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
749#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100750#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100751
tll68c28172017-06-24 08:38:32 +0800752// Whether to check for valid UTF-8 when converting bytes to str
753#ifndef MICROPY_PY_BUILTINS_STR_UNICODE_CHECK
754#define MICROPY_PY_BUILTINS_STR_UNICODE_CHECK (MICROPY_PY_BUILTINS_STR_UNICODE)
755#endif
756
Paul Sokolovsky1b5abfc2016-05-22 00:13:44 +0300757// Whether str.center() method provided
758#ifndef MICROPY_PY_BUILTINS_STR_CENTER
759#define MICROPY_PY_BUILTINS_STR_CENTER (0)
760#endif
761
Paul Sokolovsky56eb25f2016-08-07 06:46:55 +0300762// Whether str.partition()/str.rpartition() method provided
763#ifndef MICROPY_PY_BUILTINS_STR_PARTITION
764#define MICROPY_PY_BUILTINS_STR_PARTITION (0)
765#endif
766
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300767// Whether str.splitlines() method provided
768#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
769#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
770#endif
771
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300772// Whether to support bytearray object
773#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
774#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300775#endif
776
Damien Georgedd4f4532014-10-23 13:34:35 +0100777// Whether to support memoryview object
778#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
779#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
780#endif
781
Damien George3ebd4d02014-06-01 13:46:47 +0100782// Whether to support set object
783#ifndef MICROPY_PY_BUILTINS_SET
784#define MICROPY_PY_BUILTINS_SET (1)
785#endif
786
Damien Georgefb510b32014-06-01 13:32:54 +0100787// Whether to support slice subscript operators and slice object
788#ifndef MICROPY_PY_BUILTINS_SLICE
789#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100790#endif
791
Tom Soulanilleaeb62f92015-09-11 14:31:32 -0700792// Whether to support slice attribute read access,
793// i.e. slice.start, slice.stop, slice.step
794#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
795#define MICROPY_PY_BUILTINS_SLICE_ATTRS (0)
796#endif
797
Damien Georgeee3fd462014-05-24 23:03:12 +0100798// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100799#ifndef MICROPY_PY_BUILTINS_FROZENSET
800#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100801#endif
802
Damien Georgefb510b32014-06-01 13:32:54 +0100803// Whether to support property object
804#ifndef MICROPY_PY_BUILTINS_PROPERTY
805#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100806#endif
807
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500808// Whether to implement the start/stop/step attributes (readback) on
809// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
810#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
811#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
812#endif
813
Damien Georged77da832018-02-14 23:17:06 +1100814// Whether to support binary ops [only (in)equality is defined] between range
815// objects. With this option disabled all range objects that are not exactly
816// the same object will compare as not-equal. With it enabled the semantics
817// match CPython and ranges are equal if they yield the same sequence of items.
818#ifndef MICROPY_PY_BUILTINS_RANGE_BINOP
819#define MICROPY_PY_BUILTINS_RANGE_BINOP (0)
820#endif
821
Jan Klusacekb318ebf2018-01-09 22:47:35 +0100822// Whether to support rounding of integers (incl bignum); eg round(123,-1)=120
823#ifndef MICROPY_PY_BUILTINS_ROUND_INT
824#define MICROPY_PY_BUILTINS_ROUND_INT (0)
825#endif
826
Daniel Campora077812b2015-06-29 22:45:39 +0200827// Whether to support timeout exceptions (like socket.timeout)
828#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
829#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
830#endif
831
Paul Sokolovsky0e80f342017-10-27 22:29:15 +0300832// Whether to support complete set of special methods for user
833// classes, or only the most used ones. "Inplace" methods are
834// controlled by MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS below.
835// "Reverse" methods are controlled by
836// MICROPY_PY_REVERSE_SPECIAL_METHODS below.
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200837#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
838#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
839#endif
840
Paul Sokolovsky0e80f342017-10-27 22:29:15 +0300841// Whether to support all inplace arithmetic operarion methods
842// (__imul__, etc.)
843#ifndef MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS
844#define MICROPY_PY_ALL_INPLACE_SPECIAL_METHODS (0)
845#endif
846
847// Whether to support reverse arithmetic operarion methods
848// (__radd__, etc.). Additionally gated by
849// MICROPY_PY_ALL_SPECIAL_METHODS.
Paul Sokolovskyeb84a832017-09-10 17:05:20 +0300850#ifndef MICROPY_PY_REVERSE_SPECIAL_METHODS
851#define MICROPY_PY_REVERSE_SPECIAL_METHODS (0)
852#endif
853
Damien Georgec9fc6202014-10-25 21:59:14 +0100854// Whether to support compile function
855#ifndef MICROPY_PY_BUILTINS_COMPILE
856#define MICROPY_PY_BUILTINS_COMPILE (0)
857#endif
858
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300859// Whether to support enumerate function(type)
860#ifndef MICROPY_PY_BUILTINS_ENUMERATE
861#define MICROPY_PY_BUILTINS_ENUMERATE (1)
862#endif
863
Damien Georgedd5353a2015-12-18 12:35:44 +0000864// Whether to support eval and exec functions
865// By default they are supported if the compiler is enabled
866#ifndef MICROPY_PY_BUILTINS_EVAL_EXEC
867#define MICROPY_PY_BUILTINS_EVAL_EXEC (MICROPY_ENABLE_COMPILER)
868#endif
869
Damien George2a3e2b92014-12-19 13:36:17 +0000870// Whether to support the Python 2 execfile function
871#ifndef MICROPY_PY_BUILTINS_EXECFILE
872#define MICROPY_PY_BUILTINS_EXECFILE (0)
873#endif
874
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300875// Whether to support filter function(type)
876#ifndef MICROPY_PY_BUILTINS_FILTER
877#define MICROPY_PY_BUILTINS_FILTER (1)
878#endif
879
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300880// Whether to support reversed function(type)
881#ifndef MICROPY_PY_BUILTINS_REVERSED
882#define MICROPY_PY_BUILTINS_REVERSED (1)
883#endif
884
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300885// Whether to define "NotImplemented" special constant
886#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
887#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
888#endif
889
Damien Georgebc763022017-06-01 15:32:23 +1000890// Whether to provide the built-in input() function. The implementation of this
891// uses mp-readline, so can only be enabled if the port uses this readline.
892#ifndef MICROPY_PY_BUILTINS_INPUT
893#define MICROPY_PY_BUILTINS_INPUT (0)
894#endif
895
pohmelie354e6882015-12-07 15:35:48 +0300896// Whether to support min/max functions
897#ifndef MICROPY_PY_BUILTINS_MIN_MAX
898#define MICROPY_PY_BUILTINS_MIN_MAX (1)
899#endif
900
Damien Georgea19b5a02017-02-03 12:35:48 +1100901// Support for calls to pow() with 3 integer arguments
902#ifndef MICROPY_PY_BUILTINS_POW3
903#define MICROPY_PY_BUILTINS_POW3 (0)
904#endif
905
Damien George9f04dfb2017-01-21 23:17:51 +1100906// Whether to provide the help function
907#ifndef MICROPY_PY_BUILTINS_HELP
908#define MICROPY_PY_BUILTINS_HELP (0)
909#endif
910
911// Use this to configure the help text shown for help(). It should be a
912// variable with the type "const char*". A sensible default is provided.
913#ifndef MICROPY_PY_BUILTINS_HELP_TEXT
914#define MICROPY_PY_BUILTINS_HELP_TEXT mp_help_default_text
915#endif
916
Damien Georgef5172af2017-01-22 12:12:54 +1100917// Add the ability to list the available modules when executing help('modules')
918#ifndef MICROPY_PY_BUILTINS_HELP_MODULES
919#define MICROPY_PY_BUILTINS_HELP_MODULES (0)
920#endif
921
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300922// Whether to set __file__ for imported modules
923#ifndef MICROPY_PY___FILE__
924#define MICROPY_PY___FILE__ (1)
925#endif
926
Damien George89deec02015-01-09 20:12:54 +0000927// Whether to provide mem-info related functions in micropython module
928#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
929#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
930#endif
931
Damien George7e2a4882018-02-20 18:30:22 +1100932// Whether to provide "micropython.stack_use" function
933#ifndef MICROPY_PY_MICROPYTHON_STACK_USE
934#define MICROPY_PY_MICROPYTHON_STACK_USE (MICROPY_PY_MICROPYTHON_MEM_INFO)
935#endif
936
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300937// Whether to provide "array" module. Note that large chunk of the
938// underlying code is shared with "bytearray" builtin type, so to
939// get real savings, it should be disabled too.
940#ifndef MICROPY_PY_ARRAY
941#define MICROPY_PY_ARRAY (1)
942#endif
943
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200944// Whether to support slice assignments for array (and bytearray).
945// This is rarely used, but adds ~0.5K of code.
946#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
947#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
948#endif
949
Damien George5aa311d2015-04-21 14:14:24 +0000950// Whether to support attrtuple type (MicroPython extension)
951// It provides space-efficient tuples with attribute access
952#ifndef MICROPY_PY_ATTRTUPLE
953#define MICROPY_PY_ATTRTUPLE (1)
954#endif
955
Damien Georgeee3fd462014-05-24 23:03:12 +0100956// Whether to provide "collections" module
957#ifndef MICROPY_PY_COLLECTIONS
958#define MICROPY_PY_COLLECTIONS (1)
959#endif
960
Paul Sokolovsky970eedc2018-02-06 00:06:42 +0200961// Whether to provide "ucollections.deque" type
962#ifndef MICROPY_PY_COLLECTIONS_DEQUE
963#define MICROPY_PY_COLLECTIONS_DEQUE (0)
964#endif
965
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200966// Whether to provide "collections.OrderedDict" type
967#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
968#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
969#endif
970
stijn79ed58f2017-11-06 12:21:53 +0100971// Whether to provide the _asdict function for namedtuple
972#ifndef MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
973#define MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT (0)
974#endif
975
Damien Georgeee3fd462014-05-24 23:03:12 +0100976// Whether to provide "math" module
977#ifndef MICROPY_PY_MATH
978#define MICROPY_PY_MATH (1)
979#endif
980
Damien George5cbeace2015-02-22 14:48:18 +0000981// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
982#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
983#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
984#endif
985
Damien Georgeee3fd462014-05-24 23:03:12 +0100986// Whether to provide "cmath" module
987#ifndef MICROPY_PY_CMATH
988#define MICROPY_PY_CMATH (0)
989#endif
990
991// Whether to provide "gc" module
992#ifndef MICROPY_PY_GC
993#define MICROPY_PY_GC (1)
994#endif
995
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300996// Whether to return number of collected objects from gc.collect()
997#ifndef MICROPY_PY_GC_COLLECT_RETVAL
998#define MICROPY_PY_GC_COLLECT_RETVAL (0)
999#endif
1000
Damien Georgeee3fd462014-05-24 23:03:12 +01001001// Whether to provide "io" module
1002#ifndef MICROPY_PY_IO
1003#define MICROPY_PY_IO (1)
1004#endif
1005
Damien Georgeaf0932a2018-06-04 15:54:26 +10001006// Whether to provide "io.IOBase" class to support user streams
1007#ifndef MICROPY_PY_IO_IOBASE
1008#define MICROPY_PY_IO_IOBASE (0)
1009#endif
1010
Paul Sokolovskyd7da2db2017-05-03 01:47:08 +03001011// Whether to provide "uio.resource_stream()" function with
1012// the semantics of CPython's pkg_resources.resource_stream()
Paul Sokolovskye7fc7652017-12-10 02:15:43 +02001013// (allows to access binary resources in frozen source packages).
1014// Note that the same functionality can be achieved in "pure
1015// Python" by prepocessing binary resources into Python source
1016// and bytecode-freezing it (with a simple helper module available
1017// e.g. in micropython-lib).
Paul Sokolovskyd7da2db2017-05-03 01:47:08 +03001018#ifndef MICROPY_PY_IO_RESOURCE_STREAM
1019#define MICROPY_PY_IO_RESOURCE_STREAM (0)
1020#endif
1021
Damien Georgeee3fd462014-05-24 23:03:12 +01001022// Whether to provide "io.FileIO" class
1023#ifndef MICROPY_PY_IO_FILEIO
1024#define MICROPY_PY_IO_FILEIO (0)
1025#endif
1026
1027// Whether to provide "io.BytesIO" class
1028#ifndef MICROPY_PY_IO_BYTESIO
1029#define MICROPY_PY_IO_BYTESIO (1)
1030#endif
1031
Paul Sokolovsky5d93dfb2016-03-25 01:10:49 +02001032// Whether to provide "io.BufferedWriter" class
1033#ifndef MICROPY_PY_IO_BUFFEREDWRITER
1034#define MICROPY_PY_IO_BUFFEREDWRITER (0)
1035#endif
1036
Damien Georgeee3fd462014-05-24 23:03:12 +01001037// Whether to provide "struct" module
1038#ifndef MICROPY_PY_STRUCT
1039#define MICROPY_PY_STRUCT (1)
1040#endif
1041
1042// Whether to provide "sys" module
1043#ifndef MICROPY_PY_SYS
1044#define MICROPY_PY_SYS (1)
1045#endif
1046
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +03001047// Whether to provide "sys.maxsize" constant
1048#ifndef MICROPY_PY_SYS_MAXSIZE
1049#define MICROPY_PY_SYS_MAXSIZE (0)
1050#endif
1051
Paul Sokolovsky1a1d11f2015-12-05 00:09:10 +02001052// Whether to provide "sys.modules" dictionary
1053#ifndef MICROPY_PY_SYS_MODULES
1054#define MICROPY_PY_SYS_MODULES (1)
1055#endif
1056
Paul Sokolovsky8b85d142015-04-25 03:17:41 +03001057// Whether to provide "sys.exc_info" function
1058// Avoid enabling this, this function is Python2 heritage
1059#ifndef MICROPY_PY_SYS_EXC_INFO
1060#define MICROPY_PY_SYS_EXC_INFO (0)
1061#endif
1062
Damien Georgeee3fd462014-05-24 23:03:12 +01001063// Whether to provide "sys.exit" function
1064#ifndef MICROPY_PY_SYS_EXIT
Paul Sokolovsky403c9302016-12-14 21:10:22 +03001065#define MICROPY_PY_SYS_EXIT (1)
Damien Georgeee3fd462014-05-24 23:03:12 +01001066#endif
1067
Paul Sokolovskybfc20922017-08-11 09:42:39 +03001068// Whether to provide "sys.getsizeof" function
1069#ifndef MICROPY_PY_SYS_GETSIZEOF
1070#define MICROPY_PY_SYS_GETSIZEOF (0)
1071#endif
1072
Damien Georgeee3fd462014-05-24 23:03:12 +01001073// Whether to provide sys.{stdin,stdout,stderr} objects
1074#ifndef MICROPY_PY_SYS_STDFILES
1075#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +01001076#endif
1077
Damien George3c4b5d42015-05-13 23:49:21 +01001078// Whether to provide sys.{stdin,stdout,stderr}.buffer object
1079// This is implemented per-port
1080#ifndef MICROPY_PY_SYS_STDIO_BUFFER
1081#define MICROPY_PY_SYS_STDIO_BUFFER (0)
1082#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +03001083
Damien George596a3fe2016-05-10 10:54:25 +01001084// Whether to provide "uerrno" module
1085#ifndef MICROPY_PY_UERRNO
1086#define MICROPY_PY_UERRNO (0)
1087#endif
1088
Damien Georgef5634062017-02-22 12:53:42 +11001089// Whether to provide the uerrno.errorcode dict
1090#ifndef MICROPY_PY_UERRNO_ERRORCODE
1091#define MICROPY_PY_UERRNO_ERRORCODE (1)
1092#endif
1093
Paul Sokolovsky8f5bc3f2016-11-20 23:49:45 +03001094// Whether to provide "uselect" module (baremetal implementation)
1095#ifndef MICROPY_PY_USELECT
1096#define MICROPY_PY_USELECT (0)
1097#endif
1098
Paul Sokolovskya9728442016-10-14 20:13:02 +03001099// Whether to provide "utime" module functions implementation
1100// in terms of mp_hal_* functions.
1101#ifndef MICROPY_PY_UTIME_MP_HAL
1102#define MICROPY_PY_UTIME_MP_HAL (0)
1103#endif
1104
Paul Sokolovsky76146b32016-10-30 03:02:07 +03001105// Period of values returned by utime.ticks_ms(), ticks_us(), ticks_cpu()
1106// functions. Should be power of two. All functions above use the same
1107// period, so if underlying hardware/API has different periods, the
1108// minimum of them should be used. The value below is the maximum value
1109// this parameter can take (corresponding to 30 bit tick values on 32-bit
1110// system).
1111#ifndef MICROPY_PY_UTIME_TICKS_PERIOD
1112#define MICROPY_PY_UTIME_TICKS_PERIOD (MP_SMALL_INT_POSITIVE_MASK + 1)
1113#endif
1114
Damien George27cc0772016-04-22 22:52:33 +00001115// Whether to provide "_thread" module
1116#ifndef MICROPY_PY_THREAD
1117#define MICROPY_PY_THREAD (0)
1118#endif
1119
Damien George4cec63a2016-05-26 10:42:53 +00001120// Whether to make the VM/runtime thread-safe using a global lock
1121// If not enabled then thread safety must be provided at the Python level
1122#ifndef MICROPY_PY_THREAD_GIL
1123#define MICROPY_PY_THREAD_GIL (MICROPY_PY_THREAD)
1124#endif
1125
Damien Georgef6c22a02017-02-06 10:50:43 +11001126// Number of VM jump-loops to do before releasing the GIL.
1127// Set this to 0 to disable the divisor.
1128#ifndef MICROPY_PY_THREAD_GIL_VM_DIVISOR
1129#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
1130#endif
1131
Paul Sokolovsky82158472014-06-28 03:03:47 +03001132// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +03001133
Paul Sokolovsky82158472014-06-28 03:03:47 +03001134#ifndef MICROPY_PY_UCTYPES
1135#define MICROPY_PY_UCTYPES (0)
1136#endif
1137
Paul Sokolovsky34162872014-10-12 08:16:34 -07001138#ifndef MICROPY_PY_UZLIB
1139#define MICROPY_PY_UZLIB (0)
1140#endif
1141
Damien George612045f2014-09-17 22:56:34 +01001142#ifndef MICROPY_PY_UJSON
1143#define MICROPY_PY_UJSON (0)
1144#endif
1145
Paul Sokolovskyc71e0452014-09-12 18:48:07 +03001146#ifndef MICROPY_PY_URE
1147#define MICROPY_PY_URE (0)
1148#endif
1149
Damien George1f864602018-05-24 13:07:42 +10001150#ifndef MICROPY_PY_URE_MATCH_GROUPS
1151#define MICROPY_PY_URE_MATCH_GROUPS (0)
1152#endif
1153
Damien George1e9b8712018-05-24 13:08:15 +10001154#ifndef MICROPY_PY_URE_MATCH_SPAN_START_END
1155#define MICROPY_PY_URE_MATCH_SPAN_START_END (0)
1156#endif
1157
Damien Georgee30a5fc2018-05-24 13:08:51 +10001158#ifndef MICROPY_PY_URE_SUB
1159#define MICROPY_PY_URE_SUB (0)
1160#endif
1161
Damien Georgef5d69792014-10-22 17:37:18 +00001162#ifndef MICROPY_PY_UHEAPQ
1163#define MICROPY_PY_UHEAPQ (0)
1164#endif
1165
Paul Sokolovskyd02f6a92016-12-22 00:29:32 +03001166// Optimized heap queue for relative timestamps
1167#ifndef MICROPY_PY_UTIMEQ
1168#define MICROPY_PY_UTIMEQ (0)
1169#endif
1170
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +02001171#ifndef MICROPY_PY_UHASHLIB
1172#define MICROPY_PY_UHASHLIB (0)
1173#endif
1174
Yonatan Goldschmidt66303542018-06-09 02:48:29 +03001175#ifndef MICROPY_PY_UHASHLIB_SHA1
1176#define MICROPY_PY_UHASHLIB_SHA1 (0)
1177#endif
1178
1179#ifndef MICROPY_PY_UHASHLIB_SHA256
1180#define MICROPY_PY_UHASHLIB_SHA256 (1)
1181#endif
1182
Paul Sokolovsky567bc2d2018-01-07 15:13:56 +02001183#ifndef MICROPY_PY_UCRYPTOLIB
1184#define MICROPY_PY_UCRYPTOLIB (0)
1185#endif
1186
Yonatan Goldschmidt473fe452018-06-15 17:07:47 +03001187#ifndef MICROPY_PY_UCRYPTOLIB_CONSTS
1188#define MICROPY_PY_UCRYPTOLIB_CONSTS (0)
1189#endif
1190
Paul Sokolovskybfdc2052014-11-29 06:19:30 +02001191#ifndef MICROPY_PY_UBINASCII
1192#define MICROPY_PY_UBINASCII (0)
1193#endif
1194
Paul Sokolovskyc4283672016-08-24 18:28:43 +03001195// Depends on MICROPY_PY_UZLIB
1196#ifndef MICROPY_PY_UBINASCII_CRC32
1197#define MICROPY_PY_UBINASCII_CRC32 (0)
1198#endif
1199
Paul Sokolovskya58a91e2016-01-17 12:10:28 +02001200#ifndef MICROPY_PY_URANDOM
1201#define MICROPY_PY_URANDOM (0)
1202#endif
1203
Damien Georgea53af6c2016-01-22 16:19:32 +00001204// Whether to include: randrange, randint, choice, random, uniform
1205#ifndef MICROPY_PY_URANDOM_EXTRA_FUNCS
1206#define MICROPY_PY_URANDOM_EXTRA_FUNCS (0)
1207#endif
1208
Paul Sokolovsky01162182015-05-03 20:25:40 +03001209#ifndef MICROPY_PY_MACHINE
1210#define MICROPY_PY_MACHINE (0)
1211#endif
1212
Damien George33168082016-05-31 14:25:19 +01001213// Whether to include: time_pulse_us
1214#ifndef MICROPY_PY_MACHINE_PULSE
1215#define MICROPY_PY_MACHINE_PULSE (0)
1216#endif
1217
Damien Georged0837122016-04-12 13:42:35 +01001218#ifndef MICROPY_PY_MACHINE_I2C
1219#define MICROPY_PY_MACHINE_I2C (0)
1220#endif
1221
Damien George0823c1b2016-09-01 15:07:20 +10001222#ifndef MICROPY_PY_MACHINE_SPI
1223#define MICROPY_PY_MACHINE_SPI (0)
1224#endif
1225
Paul Sokolovskyaaa88672015-10-06 18:10:00 +03001226#ifndef MICROPY_PY_USSL
1227#define MICROPY_PY_USSL (0)
Eric Poulsen74ec52d2017-10-26 21:17:35 -07001228// Whether to add finaliser code to ussl objects
1229#define MICROPY_PY_USSL_FINALISER (0)
Paul Sokolovskyaaa88672015-10-06 18:10:00 +03001230#endif
1231
Paul Sokolovsky24342dd2016-03-24 19:14:12 +02001232#ifndef MICROPY_PY_WEBSOCKET
1233#define MICROPY_PY_WEBSOCKET (0)
1234#endif
1235
Damien George53ad6812016-04-08 11:08:37 +01001236#ifndef MICROPY_PY_FRAMEBUF
1237#define MICROPY_PY_FRAMEBUF (0)
1238#endif
1239
Paul Sokolovsky737bd9c2016-07-02 14:57:42 +03001240#ifndef MICROPY_PY_BTREE
1241#define MICROPY_PY_BTREE (0)
1242#endif
1243
Damien George58ebde42014-05-21 20:32:59 +01001244/*****************************************************************************/
1245/* Hooks for a port to add builtins */
1246
Damien Georgecaac5422014-03-25 14:18:18 +00001247// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001248#ifndef MICROPY_PORT_BUILTINS
1249#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +02001250#endif
Damien Georgecaac5422014-03-25 14:18:18 +00001251
1252// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001253#ifndef MICROPY_PORT_BUILTIN_MODULES
1254#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +00001255#endif
1256
Damien Georgec14a8162014-10-12 11:46:04 +01001257// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
1258#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1259#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1260#endif
1261
Damien George57e99eb2014-04-10 22:42:11 +01001262// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +01001263#ifndef MICROPY_PORT_CONSTANTS
1264#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +01001265#endif
1266
Damien Georgeb4b10fd2015-01-01 23:30:53 +00001267// Any root pointers for GC scanning - see mpstate.c
1268#ifndef MICROPY_PORT_ROOT_POINTERS
1269#define MICROPY_PORT_ROOT_POINTERS
1270#endif
1271
Damien George136f6752014-01-07 14:54:15 +00001272/*****************************************************************************/
1273/* Miscellaneous settings */
1274
Damien George28631532015-02-08 13:42:00 +00001275// All uPy objects in ROM must be aligned on at least a 4 byte boundary
1276// so that the small-int/qstr/pointer distinction can be made. For machines
1277// that don't do this (eg 16-bit CPU), define the following macro to something
1278// like __attribute__((aligned(4))).
1279#ifndef MICROPY_OBJ_BASE_ALIGNMENT
1280#define MICROPY_OBJ_BASE_ALIGNMENT
1281#endif
1282
Dave Hylands5b7fd202014-07-01 23:46:53 -07001283// On embedded platforms, these will typically enable/disable irqs.
1284#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001285#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001286#endif
1287#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001288#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001289#endif
1290
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +02001291// Allow to override static modifier for global objects, e.g. to use with
1292// object code analysis tools which don't support static symbols.
1293#ifndef STATIC
1294#define STATIC static
1295#endif
1296
Damien George4c307bf2017-04-01 11:39:38 +11001297// Number of bytes in a word
1298#ifndef BYTES_PER_WORD
1299#define BYTES_PER_WORD (sizeof(mp_uint_t))
1300#endif
1301
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001302#define BITS_PER_BYTE (8)
1303#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +01001304// mp_int_t value with most significant bit set
1305#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001306
Damien Georgea9bcd512014-10-06 13:44:59 +00001307// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
1308// defined and that they are the opposite of each other.
1309#if defined(MP_ENDIANNESS_LITTLE)
1310#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
1311#elif defined(MP_ENDIANNESS_BIG)
1312#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
1313#else
Damien George96303762018-05-07 13:36:52 +10001314 // Endianness not defined by port so try to autodetect it.
Damien Georgea9bcd512014-10-06 13:44:59 +00001315 #if defined(__BYTE_ORDER__)
1316 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
1317 #define MP_ENDIANNESS_LITTLE (1)
Damien George96303762018-05-07 13:36:52 +10001318 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
Damien Georgea9bcd512014-10-06 13:44:59 +00001319 #define MP_ENDIANNESS_LITTLE (0)
1320 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001321 #else
Damien George4e4772b2015-05-30 23:12:30 +01001322 #include <endian.h>
1323 #if defined(__BYTE_ORDER)
1324 #if __BYTE_ORDER == __LITTLE_ENDIAN
1325 #define MP_ENDIANNESS_LITTLE (1)
Damien George96303762018-05-07 13:36:52 +10001326 #elif __BYTE_ORDER == __BIG_ENDIAN
Damien George4e4772b2015-05-30 23:12:30 +01001327 #define MP_ENDIANNESS_LITTLE (0)
1328 #endif
Damien George4e4772b2015-05-30 23:12:30 +01001329 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001330 #endif
Damien George96303762018-05-07 13:36:52 +10001331 #ifndef MP_ENDIANNESS_LITTLE
1332 #error endianness not defined and cannot detect it
1333 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001334 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +01001335#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +03001336
Damien George3c658a42014-08-24 16:28:17 +01001337// Make a pointer to RAM callable (eg set lower bit for Thumb code)
1338// (This scheme won't work if we want to mix Thumb and normal ARM code.)
1339#ifndef MICROPY_MAKE_POINTER_CALLABLE
1340#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
1341#endif
1342
Damien George7f9d1d62015-04-09 23:56:15 +01001343// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +00001344// must be somehow reachable for marking by the GC, since the native code
1345// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +02001346#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +00001347#define MP_PLAT_ALLOC_EXEC(min_size, ptr, size) do { *ptr = m_new(byte, min_size); *size = min_size; } while (0)
Fabian Vogtb7235b82014-09-03 16:59:33 +02001348#endif
1349
1350#ifndef MP_PLAT_FREE_EXEC
1351#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
1352#endif
1353
Damien George7f9d1d62015-04-09 23:56:15 +01001354// This macro is used to do all output (except when MICROPY_PY_IO is defined)
1355#ifndef MP_PLAT_PRINT_STRN
Damien George4300c7d2015-10-15 00:05:55 +01001356#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
Damien George7f9d1d62015-04-09 23:56:15 +01001357#endif
1358
Paul Sokolovsky722e5622014-09-06 19:17:23 +03001359#ifndef MP_SSIZE_MAX
1360#define MP_SSIZE_MAX SSIZE_MAX
1361#endif
1362
Damien George40f3c022014-07-03 13:25:24 +01001363// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +00001364#ifndef INT_FMT
stijn3baf6b52015-11-20 15:59:06 +01001365#if defined(__LP64__)
Damien George40f3c022014-07-03 13:25:24 +01001366// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001367#define UINT_FMT "%lu"
1368#define INT_FMT "%ld"
stijn3baf6b52015-11-20 15:59:06 +01001369#elif defined(_WIN64)
stijn0a4eb4d2015-12-18 10:20:33 +01001370#define UINT_FMT "%llu"
1371#define INT_FMT "%lld"
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001372#else
Damien George40f3c022014-07-03 13:25:24 +01001373// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001374#define UINT_FMT "%u"
1375#define INT_FMT "%d"
1376#endif
1377#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +03001378
1379// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +02001380#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +03001381#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +02001382#endif
mux5c8db482014-06-21 17:24:55 +02001383
1384// Modifier for weak functions
1385#ifndef MP_WEAK
1386#define MP_WEAK __attribute__((weak))
1387#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001388
Paul Sokolovsky0f5bf1a2016-06-15 23:52:00 +03001389// Modifier for functions which should be never inlined
1390#ifndef MP_NOINLINE
1391#define MP_NOINLINE __attribute__((noinline))
1392#endif
1393
Paul Sokolovsky1bc29112016-08-07 22:36:05 +03001394// Modifier for functions which should be always inlined
1395#ifndef MP_ALWAYSINLINE
1396#define MP_ALWAYSINLINE __attribute__((always_inline))
1397#endif
1398
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001399// Condition is likely to be true, to help branch prediction
1400#ifndef MP_LIKELY
1401#define MP_LIKELY(x) __builtin_expect((x), 1)
1402#endif
1403
1404// Condition is likely to be false, to help branch prediction
1405#ifndef MP_UNLIKELY
1406#define MP_UNLIKELY(x) __builtin_expect((x), 0)
1407#endif
Damien George9ddbe292014-12-29 01:02:19 +00001408
Paul Sokolovsky1b146e92017-11-08 19:45:18 +02001409#ifndef MP_HTOBE16
1410#if MP_ENDIANNESS_LITTLE
1411# define MP_HTOBE16(x) ((uint16_t)( (((x) & 0xff) << 8) | (((x) >> 8) & 0xff) ))
1412# define MP_BE16TOH(x) MP_HTOBE16(x)
1413#else
1414# define MP_HTOBE16(x) (x)
1415# define MP_BE16TOH(x) (x)
1416#endif
1417#endif
1418
1419#ifndef MP_HTOBE32
1420#if MP_ENDIANNESS_LITTLE
1421# define MP_HTOBE32(x) ((uint32_t)( (((x) & 0xff) << 24) | (((x) & 0xff00) << 8) | (((x) >> 8) & 0xff00) | (((x) >> 24) & 0xff) ))
1422# define MP_BE32TOH(x) MP_HTOBE32(x)
1423#else
1424# define MP_HTOBE32(x) (x)
1425# define MP_BE32TOH(x) (x)
1426#endif
1427#endif
1428
Alexander Steffen299bc622017-06-29 23:14:58 +02001429#endif // MICROPY_INCLUDED_PY_MPCONFIG_H