blob: 38cf4b560548ffe094f624cedfd50680617a06a5 [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
82// - 01111111 11111101 00000000 00000000 iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int
83// - 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
350// Cost 156 bytes (Thumb2)
351#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 Georgecbd2f742014-01-19 11:48:48 +0000369// Whether to build functions that print debugging info:
Damien George3417bc22014-05-10 10:36:38 +0100370// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000371// mp_parse_node_print
372#ifndef MICROPY_DEBUG_PRINTERS
373#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000374#endif
375
Stefan Naumannace9fb52017-07-24 18:55:14 +0200376// Whether to enable all debugging outputs (it will be extremely verbose)
377#ifndef MICROPY_DEBUG_VERBOSE
378#define MICROPY_DEBUG_VERBOSE (0)
379#endif
380
Damien George136f6752014-01-07 14:54:15 +0000381/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100382/* Optimisations */
383
384// Whether to use computed gotos in the VM, or a switch
385// Computed gotos are roughly 10% faster, and increase VM code size by a little
386#ifndef MICROPY_OPT_COMPUTED_GOTO
387#define MICROPY_OPT_COMPUTED_GOTO (0)
388#endif
389
Damien George7ee91cf2015-01-06 12:51:39 +0000390// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
391// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
392// uses a bit of extra code ROM, but greatly improves lookup speed.
393#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
394#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
395#endif
396
Doug Currie2e2e15c2016-01-30 22:35:58 -0500397// Whether to use fast versions of bitwise operations (and, or, xor) when the
398// arguments are both positive. Increases Thumb2 code size by about 250 bytes.
399#ifndef MICROPY_OPT_MPZ_BITWISE
400#define MICROPY_OPT_MPZ_BITWISE (0)
401#endif
402
Damien Georgeee3fd462014-05-24 23:03:12 +0100403/*****************************************************************************/
404/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000405
Damien George6b239c22016-11-16 16:04:57 +1100406// Whether to use the POSIX reader for importing files
407#ifndef MICROPY_READER_POSIX
408#define MICROPY_READER_POSIX (0)
409#endif
410
Damien Georgedcb9ea72017-01-27 15:10:09 +1100411// Whether to use the VFS reader for importing files
412#ifndef MICROPY_READER_VFS
413#define MICROPY_READER_VFS (0)
414#endif
415
Damien George40d84302016-02-15 22:46:21 +0000416// Hook for the VM at the start of the opcode loop (can contain variable
417// definitions usable by the other hook functions)
418#ifndef MICROPY_VM_HOOK_INIT
419#define MICROPY_VM_HOOK_INIT
420#endif
421
422// Hook for the VM during the opcode loop (but only after jump opcodes)
423#ifndef MICROPY_VM_HOOK_LOOP
424#define MICROPY_VM_HOOK_LOOP
425#endif
426
427// Hook for the VM just before return opcode is finished being interpreted
428#ifndef MICROPY_VM_HOOK_RETURN
429#define MICROPY_VM_HOOK_RETURN
430#endif
431
Damien Georged3ebe482014-01-07 15:20:33 +0000432// Whether to include the garbage collector
433#ifndef MICROPY_ENABLE_GC
434#define MICROPY_ENABLE_GC (0)
435#endif
436
Damien George12bab722014-04-05 20:35:48 +0100437// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000438#ifndef MICROPY_ENABLE_FINALISER
439#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100440#endif
441
Paul Sokolovsky23668692014-06-25 03:03:34 +0300442// Whether to check C stack usage. C stack used for calling Python functions,
443// etc. Not checking means segfault on overflow.
444#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000445#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300446#endif
447
Dave Hylands5b7fd202014-07-01 23:46:53 -0700448// Whether to have an emergency exception buffer
449#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
450#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
451#endif
452#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
453# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
454# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
455# endif
456#endif
457
Damien Georgebbb4b982017-04-10 17:19:36 +1000458// Whether to provide the mp_kbd_exception object, and micropython.kbd_intr function
Damien George7f1da0a2016-12-15 13:00:19 +1100459#ifndef MICROPY_KBD_EXCEPTION
460#define MICROPY_KBD_EXCEPTION (0)
461#endif
462
Paul Sokolovsky1c9210b2015-12-23 00:06:37 +0200463// Prefer to raise KeyboardInterrupt asynchronously (from signal or interrupt
464// handler) - if supported by a particular port.
465#ifndef MICROPY_ASYNC_KBD_INTR
466#define MICROPY_ASYNC_KBD_INTR (0)
467#endif
468
Damien George136f6752014-01-07 14:54:15 +0000469// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100470#ifndef MICROPY_HELPER_REPL
471#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000472#endif
473
Tom Soulanille7d588b02015-07-09 16:32:36 -0700474// Whether to include emacs-style readline behavior in REPL
475#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100476#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700477#endif
478
Damien George0af73012015-08-20 10:34:16 +0100479// Whether to implement auto-indent in REPL
480#ifndef MICROPY_REPL_AUTO_INDENT
481#define MICROPY_REPL_AUTO_INDENT (0)
482#endif
483
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200484// Whether port requires event-driven REPL functions
485#ifndef MICROPY_REPL_EVENT_DRIVEN
486#define MICROPY_REPL_EVENT_DRIVEN (0)
487#endif
488
Damien Georged3ebe482014-01-07 15:20:33 +0000489// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100490#ifndef MICROPY_HELPER_LEXER_UNIX
491#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000492#endif
493
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200494// Long int implementation
495#define MICROPY_LONGINT_IMPL_NONE (0)
496#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000497#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200498
499#ifndef MICROPY_LONGINT_IMPL
500#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
501#endif
502
503#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
504typedef long long mp_longint_impl_t;
505#endif
506
Damien George62ad1892014-01-29 21:51:51 +0000507// Whether to include information in the byte code to determine source
508// line number (increases RAM usage, but doesn't slow byte code execution)
509#ifndef MICROPY_ENABLE_SOURCE_LINE
510#define MICROPY_ENABLE_SOURCE_LINE (0)
511#endif
512
Damien George1463c1f2014-04-25 23:52:57 +0100513// Whether to include doc strings (increases RAM usage)
514#ifndef MICROPY_ENABLE_DOC_STRING
515#define MICROPY_ENABLE_DOC_STRING (0)
516#endif
517
Damien George1e9a92f2014-11-06 17:36:16 +0000518// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300519#define MICROPY_ERROR_REPORTING_TERSE (1)
520// Exception messages provide basic error details
521#define MICROPY_ERROR_REPORTING_NORMAL (2)
522// Exception messages provide full info, e.g. object names
523#define MICROPY_ERROR_REPORTING_DETAILED (3)
524
525#ifndef MICROPY_ERROR_REPORTING
526#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
527#endif
528
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200529// Whether issue warnings during compiling/execution
530#ifndef MICROPY_WARNINGS
531#define MICROPY_WARNINGS (0)
532#endif
533
Damien George0c36da02014-03-08 15:24:39 +0000534// Float and complex implementation
535#define MICROPY_FLOAT_IMPL_NONE (0)
536#define MICROPY_FLOAT_IMPL_FLOAT (1)
537#define MICROPY_FLOAT_IMPL_DOUBLE (2)
538
539#ifndef MICROPY_FLOAT_IMPL
540#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
541#endif
542
543#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100544#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100545#define MICROPY_FLOAT_CONST(x) x##F
Damien George0c36da02014-03-08 15:24:39 +0000546#define MICROPY_FLOAT_C_FUN(fun) fun##f
547typedef float mp_float_t;
548#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100549#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100550#define MICROPY_FLOAT_CONST(x) x
Damien George0c36da02014-03-08 15:24:39 +0000551#define MICROPY_FLOAT_C_FUN(fun) fun
552typedef double mp_float_t;
553#else
Damien Georgefb510b32014-06-01 13:32:54 +0100554#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000555#endif
556
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300557#ifndef MICROPY_PY_BUILTINS_COMPLEX
558#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
559#endif
560
Damien Georgea73501b2017-04-06 17:27:33 +1000561// Whether to provide a high-quality hash for float and complex numbers.
562// Otherwise the default is a very simple but correct hashing function.
563#ifndef MICROPY_FLOAT_HIGH_QUALITY_HASH
564#define MICROPY_FLOAT_HIGH_QUALITY_HASH (0)
565#endif
566
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200567// Enable features which improve CPython compatibility
568// but may lead to more code size/memory usage.
569// TODO: Originally intended as generic category to not
570// add bunch of once-off options. May need refactoring later
571#ifndef MICROPY_CPYTHON_COMPAT
572#define MICROPY_CPYTHON_COMPAT (1)
573#endif
574
Paul Sokolovsky9a973972017-04-02 21:20:07 +0300575// Perform full checks as done by CPython. Disabling this
576// may produce incorrect results, if incorrect data is fed,
577// but should not lead to MicroPython crashes or similar
578// grave issues (in other words, only user app should be,
579// affected, not system).
580#ifndef MICROPY_FULL_CHECKS
581#define MICROPY_FULL_CHECKS (1)
582#endif
583
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300584// Whether POSIX-semantics non-blocking streams are supported
585#ifndef MICROPY_STREAMS_NON_BLOCK
586#define MICROPY_STREAMS_NON_BLOCK (0)
587#endif
588
Paul Sokolovsky61e77a42016-07-30 20:05:56 +0300589// Whether to provide stream functions with POSIX-like signatures
590// (useful for porting existing libraries to MicroPython).
591#ifndef MICROPY_STREAMS_POSIX_API
592#define MICROPY_STREAMS_POSIX_API (0)
593#endif
594
Damien George3c9c3682015-09-15 14:56:13 +0100595// Whether to call __init__ when importing builtin modules for the first time
596#ifndef MICROPY_MODULE_BUILTIN_INIT
597#define MICROPY_MODULE_BUILTIN_INIT (0)
598#endif
599
Damien Georgec14a8162014-10-12 11:46:04 +0100600// Whether module weak links are supported
601#ifndef MICROPY_MODULE_WEAK_LINKS
602#define MICROPY_MODULE_WEAK_LINKS (0)
603#endif
604
Damien George0a2e9652016-01-31 22:24:16 +0000605// Whether frozen modules are supported in the form of strings
606#ifndef MICROPY_MODULE_FROZEN_STR
607#define MICROPY_MODULE_FROZEN_STR (0)
608#endif
609
610// Whether frozen modules are supported in the form of .mpy files
611#ifndef MICROPY_MODULE_FROZEN_MPY
612#define MICROPY_MODULE_FROZEN_MPY (0)
613#endif
614
615// Convenience macro for whether frozen modules are supported
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200616#ifndef MICROPY_MODULE_FROZEN
Damien George0a2e9652016-01-31 22:24:16 +0000617#define MICROPY_MODULE_FROZEN (MICROPY_MODULE_FROZEN_STR || MICROPY_MODULE_FROZEN_MPY)
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200618#endif
619
Damien George78d702c2014-12-09 16:19:48 +0000620// Whether you can override builtins in the builtins module
621#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
622#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
623#endif
624
Damien George06593fb2015-06-19 12:49:10 +0000625// Whether to check that the "self" argument of a builtin method has the
626// correct type. Such an explicit check is only needed if a builtin
627// method escapes to Python land without a first argument, eg
628// list.append([], 1). Without this check such calls will have undefined
629// behaviour (usually segfault) if the first argument is the wrong type.
630#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
631#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
632#endif
633
Damien George3f56fd62016-05-10 10:54:06 +0100634// Whether to use internally defined errno's (otherwise system provided ones)
635#ifndef MICROPY_USE_INTERNAL_ERRNO
636#define MICROPY_USE_INTERNAL_ERRNO (0)
637#endif
638
Delio Brignolie2ac8bb2016-08-21 11:33:37 +0200639// Whether to use internally defined *printf() functions (otherwise external ones)
640#ifndef MICROPY_USE_INTERNAL_PRINTF
641#define MICROPY_USE_INTERNAL_PRINTF (1)
642#endif
643
Damien George6e74d242017-02-16 18:05:06 +1100644// Support for internal scheduler
645#ifndef MICROPY_ENABLE_SCHEDULER
646#define MICROPY_ENABLE_SCHEDULER (0)
647#endif
648
649// Maximum number of entries in the scheduler
650#ifndef MICROPY_SCHEDULER_DEPTH
651#define MICROPY_SCHEDULER_DEPTH (4)
652#endif
653
Damien Georgedcb9ea72017-01-27 15:10:09 +1100654// Support for generic VFS sub-system
655#ifndef MICROPY_VFS
656#define MICROPY_VFS (0)
657#endif
658
Damien Georgeee3fd462014-05-24 23:03:12 +0100659/*****************************************************************************/
660/* Fine control over Python builtins, classes, modules, etc */
661
stijn3cc17c62015-02-14 18:44:31 +0100662// Whether to implement attributes on functions
663#ifndef MICROPY_PY_FUNCTION_ATTRS
664#define MICROPY_PY_FUNCTION_ATTRS (0)
665#endif
666
stijn28fa84b2015-02-14 18:43:54 +0100667// Whether to support descriptors (__get__ and __set__)
668// This costs some code size and makes all load attrs and store attrs slow
669#ifndef MICROPY_PY_DESCRIPTORS
670#define MICROPY_PY_DESCRIPTORS (0)
671#endif
672
dmazzella18e65692017-01-03 11:00:12 +0100673// Whether to support class __delattr__ and __setattr__ methods
674// This costs some code size and makes all del attrs and store attrs slow
675#ifndef MICROPY_PY_DELATTR_SETATTR
676#define MICROPY_PY_DELATTR_SETATTR (0)
677#endif
678
pohmelie81ebba72016-01-27 23:23:11 +0300679// Support for async/await/async for/async with
680#ifndef MICROPY_PY_ASYNC_AWAIT
681#define MICROPY_PY_ASYNC_AWAIT (1)
682#endif
683
Paul Sokolovskya1b442b2016-07-22 00:46:24 +0300684// Issue a warning when comparing str and bytes objects
Paul Sokolovsky707cae72016-07-22 00:34:34 +0300685#ifndef MICROPY_PY_STR_BYTES_CMP_WARN
686#define MICROPY_PY_STR_BYTES_CMP_WARN (0)
687#endif
688
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300689// Whether str object is proper unicode
690#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
691#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100692#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100693
tll68c28172017-06-24 08:38:32 +0800694// Whether to check for valid UTF-8 when converting bytes to str
695#ifndef MICROPY_PY_BUILTINS_STR_UNICODE_CHECK
696#define MICROPY_PY_BUILTINS_STR_UNICODE_CHECK (MICROPY_PY_BUILTINS_STR_UNICODE)
697#endif
698
Paul Sokolovsky1b5abfc2016-05-22 00:13:44 +0300699// Whether str.center() method provided
700#ifndef MICROPY_PY_BUILTINS_STR_CENTER
701#define MICROPY_PY_BUILTINS_STR_CENTER (0)
702#endif
703
Paul Sokolovsky56eb25f2016-08-07 06:46:55 +0300704// Whether str.partition()/str.rpartition() method provided
705#ifndef MICROPY_PY_BUILTINS_STR_PARTITION
706#define MICROPY_PY_BUILTINS_STR_PARTITION (0)
707#endif
708
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300709// Whether str.splitlines() method provided
710#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
711#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
712#endif
713
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300714// Whether to support bytearray object
715#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
716#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300717#endif
718
Damien Georgedd4f4532014-10-23 13:34:35 +0100719// Whether to support memoryview object
720#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
721#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
722#endif
723
Damien George3ebd4d02014-06-01 13:46:47 +0100724// Whether to support set object
725#ifndef MICROPY_PY_BUILTINS_SET
726#define MICROPY_PY_BUILTINS_SET (1)
727#endif
728
Damien Georgefb510b32014-06-01 13:32:54 +0100729// Whether to support slice subscript operators and slice object
730#ifndef MICROPY_PY_BUILTINS_SLICE
731#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100732#endif
733
Tom Soulanilleaeb62f92015-09-11 14:31:32 -0700734// Whether to support slice attribute read access,
735// i.e. slice.start, slice.stop, slice.step
736#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
737#define MICROPY_PY_BUILTINS_SLICE_ATTRS (0)
738#endif
739
Damien Georgeee3fd462014-05-24 23:03:12 +0100740// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100741#ifndef MICROPY_PY_BUILTINS_FROZENSET
742#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100743#endif
744
Damien Georgefb510b32014-06-01 13:32:54 +0100745// Whether to support property object
746#ifndef MICROPY_PY_BUILTINS_PROPERTY
747#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100748#endif
749
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500750// Whether to implement the start/stop/step attributes (readback) on
751// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
752#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
753#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
754#endif
755
Daniel Campora077812b2015-06-29 22:45:39 +0200756// Whether to support timeout exceptions (like socket.timeout)
757#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
758#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
759#endif
760
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200761// Whether to support complete set of special methods
762// for user classes, otherwise only the most used
763#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
764#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
765#endif
766
Damien Georgec9fc6202014-10-25 21:59:14 +0100767// Whether to support compile function
768#ifndef MICROPY_PY_BUILTINS_COMPILE
769#define MICROPY_PY_BUILTINS_COMPILE (0)
770#endif
771
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300772// Whether to support enumerate function(type)
773#ifndef MICROPY_PY_BUILTINS_ENUMERATE
774#define MICROPY_PY_BUILTINS_ENUMERATE (1)
775#endif
776
Damien Georgedd5353a2015-12-18 12:35:44 +0000777// Whether to support eval and exec functions
778// By default they are supported if the compiler is enabled
779#ifndef MICROPY_PY_BUILTINS_EVAL_EXEC
780#define MICROPY_PY_BUILTINS_EVAL_EXEC (MICROPY_ENABLE_COMPILER)
781#endif
782
Damien George2a3e2b92014-12-19 13:36:17 +0000783// Whether to support the Python 2 execfile function
784#ifndef MICROPY_PY_BUILTINS_EXECFILE
785#define MICROPY_PY_BUILTINS_EXECFILE (0)
786#endif
787
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300788// Whether to support filter function(type)
789#ifndef MICROPY_PY_BUILTINS_FILTER
790#define MICROPY_PY_BUILTINS_FILTER (1)
791#endif
792
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300793// Whether to support reversed function(type)
794#ifndef MICROPY_PY_BUILTINS_REVERSED
795#define MICROPY_PY_BUILTINS_REVERSED (1)
796#endif
797
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300798// Whether to define "NotImplemented" special constant
799#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
800#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
801#endif
802
Damien Georgebc763022017-06-01 15:32:23 +1000803// Whether to provide the built-in input() function. The implementation of this
804// uses mp-readline, so can only be enabled if the port uses this readline.
805#ifndef MICROPY_PY_BUILTINS_INPUT
806#define MICROPY_PY_BUILTINS_INPUT (0)
807#endif
808
pohmelie354e6882015-12-07 15:35:48 +0300809// Whether to support min/max functions
810#ifndef MICROPY_PY_BUILTINS_MIN_MAX
811#define MICROPY_PY_BUILTINS_MIN_MAX (1)
812#endif
813
Damien Georgea19b5a02017-02-03 12:35:48 +1100814// Support for calls to pow() with 3 integer arguments
815#ifndef MICROPY_PY_BUILTINS_POW3
816#define MICROPY_PY_BUILTINS_POW3 (0)
817#endif
818
Damien George9f04dfb2017-01-21 23:17:51 +1100819// Whether to provide the help function
820#ifndef MICROPY_PY_BUILTINS_HELP
821#define MICROPY_PY_BUILTINS_HELP (0)
822#endif
823
824// Use this to configure the help text shown for help(). It should be a
825// variable with the type "const char*". A sensible default is provided.
826#ifndef MICROPY_PY_BUILTINS_HELP_TEXT
827#define MICROPY_PY_BUILTINS_HELP_TEXT mp_help_default_text
828#endif
829
Damien Georgef5172af2017-01-22 12:12:54 +1100830// Add the ability to list the available modules when executing help('modules')
831#ifndef MICROPY_PY_BUILTINS_HELP_MODULES
832#define MICROPY_PY_BUILTINS_HELP_MODULES (0)
833#endif
834
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300835// Whether to set __file__ for imported modules
836#ifndef MICROPY_PY___FILE__
837#define MICROPY_PY___FILE__ (1)
838#endif
839
Damien George89deec02015-01-09 20:12:54 +0000840// Whether to provide mem-info related functions in micropython module
841#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
842#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
843#endif
844
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300845// Whether to provide "array" module. Note that large chunk of the
846// underlying code is shared with "bytearray" builtin type, so to
847// get real savings, it should be disabled too.
848#ifndef MICROPY_PY_ARRAY
849#define MICROPY_PY_ARRAY (1)
850#endif
851
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200852// Whether to support slice assignments for array (and bytearray).
853// This is rarely used, but adds ~0.5K of code.
854#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
855#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
856#endif
857
Damien George5aa311d2015-04-21 14:14:24 +0000858// Whether to support attrtuple type (MicroPython extension)
859// It provides space-efficient tuples with attribute access
860#ifndef MICROPY_PY_ATTRTUPLE
861#define MICROPY_PY_ATTRTUPLE (1)
862#endif
863
Damien Georgeee3fd462014-05-24 23:03:12 +0100864// Whether to provide "collections" module
865#ifndef MICROPY_PY_COLLECTIONS
866#define MICROPY_PY_COLLECTIONS (1)
867#endif
868
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200869// Whether to provide "collections.OrderedDict" type
870#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
871#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
872#endif
873
Damien Georgeee3fd462014-05-24 23:03:12 +0100874// Whether to provide "math" module
875#ifndef MICROPY_PY_MATH
876#define MICROPY_PY_MATH (1)
877#endif
878
Damien George5cbeace2015-02-22 14:48:18 +0000879// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
880#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
881#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
882#endif
883
Damien Georgeee3fd462014-05-24 23:03:12 +0100884// Whether to provide "cmath" module
885#ifndef MICROPY_PY_CMATH
886#define MICROPY_PY_CMATH (0)
887#endif
888
889// Whether to provide "gc" module
890#ifndef MICROPY_PY_GC
891#define MICROPY_PY_GC (1)
892#endif
893
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300894// Whether to return number of collected objects from gc.collect()
895#ifndef MICROPY_PY_GC_COLLECT_RETVAL
896#define MICROPY_PY_GC_COLLECT_RETVAL (0)
897#endif
898
Damien Georgeee3fd462014-05-24 23:03:12 +0100899// Whether to provide "io" module
900#ifndef MICROPY_PY_IO
901#define MICROPY_PY_IO (1)
902#endif
903
Paul Sokolovskyd7da2db2017-05-03 01:47:08 +0300904// Whether to provide "uio.resource_stream()" function with
905// the semantics of CPython's pkg_resources.resource_stream()
906// (allows to access resources in frozen packages).
907#ifndef MICROPY_PY_IO_RESOURCE_STREAM
908#define MICROPY_PY_IO_RESOURCE_STREAM (0)
909#endif
910
Damien Georgeee3fd462014-05-24 23:03:12 +0100911// Whether to provide "io.FileIO" class
912#ifndef MICROPY_PY_IO_FILEIO
913#define MICROPY_PY_IO_FILEIO (0)
914#endif
915
916// Whether to provide "io.BytesIO" class
917#ifndef MICROPY_PY_IO_BYTESIO
918#define MICROPY_PY_IO_BYTESIO (1)
919#endif
920
Paul Sokolovsky5d93dfb2016-03-25 01:10:49 +0200921// Whether to provide "io.BufferedWriter" class
922#ifndef MICROPY_PY_IO_BUFFEREDWRITER
923#define MICROPY_PY_IO_BUFFEREDWRITER (0)
924#endif
925
Damien Georgeee3fd462014-05-24 23:03:12 +0100926// Whether to provide "struct" module
927#ifndef MICROPY_PY_STRUCT
928#define MICROPY_PY_STRUCT (1)
929#endif
930
931// Whether to provide "sys" module
932#ifndef MICROPY_PY_SYS
933#define MICROPY_PY_SYS (1)
934#endif
935
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300936// Whether to provide "sys.maxsize" constant
937#ifndef MICROPY_PY_SYS_MAXSIZE
938#define MICROPY_PY_SYS_MAXSIZE (0)
939#endif
940
Paul Sokolovsky1a1d11f2015-12-05 00:09:10 +0200941// Whether to provide "sys.modules" dictionary
942#ifndef MICROPY_PY_SYS_MODULES
943#define MICROPY_PY_SYS_MODULES (1)
944#endif
945
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300946// Whether to provide "sys.exc_info" function
947// Avoid enabling this, this function is Python2 heritage
948#ifndef MICROPY_PY_SYS_EXC_INFO
949#define MICROPY_PY_SYS_EXC_INFO (0)
950#endif
951
Damien Georgeee3fd462014-05-24 23:03:12 +0100952// Whether to provide "sys.exit" function
953#ifndef MICROPY_PY_SYS_EXIT
Paul Sokolovsky403c9302016-12-14 21:10:22 +0300954#define MICROPY_PY_SYS_EXIT (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100955#endif
956
Paul Sokolovskybfc20922017-08-11 09:42:39 +0300957// Whether to provide "sys.getsizeof" function
958#ifndef MICROPY_PY_SYS_GETSIZEOF
959#define MICROPY_PY_SYS_GETSIZEOF (0)
960#endif
961
Damien Georgeee3fd462014-05-24 23:03:12 +0100962// Whether to provide sys.{stdin,stdout,stderr} objects
963#ifndef MICROPY_PY_SYS_STDFILES
964#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100965#endif
966
Damien George3c4b5d42015-05-13 23:49:21 +0100967// Whether to provide sys.{stdin,stdout,stderr}.buffer object
968// This is implemented per-port
969#ifndef MICROPY_PY_SYS_STDIO_BUFFER
970#define MICROPY_PY_SYS_STDIO_BUFFER (0)
971#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300972
Damien George596a3fe2016-05-10 10:54:25 +0100973// Whether to provide "uerrno" module
974#ifndef MICROPY_PY_UERRNO
975#define MICROPY_PY_UERRNO (0)
976#endif
977
Damien Georgef5634062017-02-22 12:53:42 +1100978// Whether to provide the uerrno.errorcode dict
979#ifndef MICROPY_PY_UERRNO_ERRORCODE
980#define MICROPY_PY_UERRNO_ERRORCODE (1)
981#endif
982
Paul Sokolovsky8f5bc3f2016-11-20 23:49:45 +0300983// Whether to provide "uselect" module (baremetal implementation)
984#ifndef MICROPY_PY_USELECT
985#define MICROPY_PY_USELECT (0)
986#endif
987
Paul Sokolovskya9728442016-10-14 20:13:02 +0300988// Whether to provide "utime" module functions implementation
989// in terms of mp_hal_* functions.
990#ifndef MICROPY_PY_UTIME_MP_HAL
991#define MICROPY_PY_UTIME_MP_HAL (0)
992#endif
993
Paul Sokolovsky76146b32016-10-30 03:02:07 +0300994// Period of values returned by utime.ticks_ms(), ticks_us(), ticks_cpu()
995// functions. Should be power of two. All functions above use the same
996// period, so if underlying hardware/API has different periods, the
997// minimum of them should be used. The value below is the maximum value
998// this parameter can take (corresponding to 30 bit tick values on 32-bit
999// system).
1000#ifndef MICROPY_PY_UTIME_TICKS_PERIOD
1001#define MICROPY_PY_UTIME_TICKS_PERIOD (MP_SMALL_INT_POSITIVE_MASK + 1)
1002#endif
1003
Damien George27cc0772016-04-22 22:52:33 +00001004// Whether to provide "_thread" module
1005#ifndef MICROPY_PY_THREAD
1006#define MICROPY_PY_THREAD (0)
1007#endif
1008
Damien George4cec63a2016-05-26 10:42:53 +00001009// Whether to make the VM/runtime thread-safe using a global lock
1010// If not enabled then thread safety must be provided at the Python level
1011#ifndef MICROPY_PY_THREAD_GIL
1012#define MICROPY_PY_THREAD_GIL (MICROPY_PY_THREAD)
1013#endif
1014
Damien Georgef6c22a02017-02-06 10:50:43 +11001015// Number of VM jump-loops to do before releasing the GIL.
1016// Set this to 0 to disable the divisor.
1017#ifndef MICROPY_PY_THREAD_GIL_VM_DIVISOR
1018#define MICROPY_PY_THREAD_GIL_VM_DIVISOR (32)
1019#endif
1020
Paul Sokolovsky82158472014-06-28 03:03:47 +03001021// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +03001022
Paul Sokolovsky82158472014-06-28 03:03:47 +03001023#ifndef MICROPY_PY_UCTYPES
1024#define MICROPY_PY_UCTYPES (0)
1025#endif
1026
Paul Sokolovsky34162872014-10-12 08:16:34 -07001027#ifndef MICROPY_PY_UZLIB
1028#define MICROPY_PY_UZLIB (0)
1029#endif
1030
Damien George612045f2014-09-17 22:56:34 +01001031#ifndef MICROPY_PY_UJSON
1032#define MICROPY_PY_UJSON (0)
1033#endif
1034
Paul Sokolovskyc71e0452014-09-12 18:48:07 +03001035#ifndef MICROPY_PY_URE
1036#define MICROPY_PY_URE (0)
1037#endif
1038
Damien Georgef5d69792014-10-22 17:37:18 +00001039#ifndef MICROPY_PY_UHEAPQ
1040#define MICROPY_PY_UHEAPQ (0)
1041#endif
1042
Paul Sokolovskyd02f6a92016-12-22 00:29:32 +03001043// Optimized heap queue for relative timestamps
1044#ifndef MICROPY_PY_UTIMEQ
1045#define MICROPY_PY_UTIMEQ (0)
1046#endif
1047
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +02001048#ifndef MICROPY_PY_UHASHLIB
1049#define MICROPY_PY_UHASHLIB (0)
1050#endif
1051
Paul Sokolovskybfdc2052014-11-29 06:19:30 +02001052#ifndef MICROPY_PY_UBINASCII
1053#define MICROPY_PY_UBINASCII (0)
1054#endif
1055
Paul Sokolovskyc4283672016-08-24 18:28:43 +03001056// Depends on MICROPY_PY_UZLIB
1057#ifndef MICROPY_PY_UBINASCII_CRC32
1058#define MICROPY_PY_UBINASCII_CRC32 (0)
1059#endif
1060
Paul Sokolovskya58a91e2016-01-17 12:10:28 +02001061#ifndef MICROPY_PY_URANDOM
1062#define MICROPY_PY_URANDOM (0)
1063#endif
1064
Damien Georgea53af6c2016-01-22 16:19:32 +00001065// Whether to include: randrange, randint, choice, random, uniform
1066#ifndef MICROPY_PY_URANDOM_EXTRA_FUNCS
1067#define MICROPY_PY_URANDOM_EXTRA_FUNCS (0)
1068#endif
1069
Paul Sokolovsky01162182015-05-03 20:25:40 +03001070#ifndef MICROPY_PY_MACHINE
1071#define MICROPY_PY_MACHINE (0)
1072#endif
1073
Damien George33168082016-05-31 14:25:19 +01001074// Whether to include: time_pulse_us
1075#ifndef MICROPY_PY_MACHINE_PULSE
1076#define MICROPY_PY_MACHINE_PULSE (0)
1077#endif
1078
Damien Georged0837122016-04-12 13:42:35 +01001079#ifndef MICROPY_PY_MACHINE_I2C
1080#define MICROPY_PY_MACHINE_I2C (0)
1081#endif
1082
Damien George0823c1b2016-09-01 15:07:20 +10001083#ifndef MICROPY_PY_MACHINE_SPI
1084#define MICROPY_PY_MACHINE_SPI (0)
1085#endif
1086
Paul Sokolovskyaaa88672015-10-06 18:10:00 +03001087#ifndef MICROPY_PY_USSL
1088#define MICROPY_PY_USSL (0)
1089#endif
1090
Paul Sokolovsky24342dd2016-03-24 19:14:12 +02001091#ifndef MICROPY_PY_WEBSOCKET
1092#define MICROPY_PY_WEBSOCKET (0)
1093#endif
1094
Damien George53ad6812016-04-08 11:08:37 +01001095#ifndef MICROPY_PY_FRAMEBUF
1096#define MICROPY_PY_FRAMEBUF (0)
1097#endif
1098
Paul Sokolovsky737bd9c2016-07-02 14:57:42 +03001099#ifndef MICROPY_PY_BTREE
1100#define MICROPY_PY_BTREE (0)
1101#endif
1102
Damien George58ebde42014-05-21 20:32:59 +01001103/*****************************************************************************/
1104/* Hooks for a port to add builtins */
1105
Damien Georgecaac5422014-03-25 14:18:18 +00001106// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001107#ifndef MICROPY_PORT_BUILTINS
1108#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +02001109#endif
Damien Georgecaac5422014-03-25 14:18:18 +00001110
1111// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001112#ifndef MICROPY_PORT_BUILTIN_MODULES
1113#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +00001114#endif
1115
Damien Georgec14a8162014-10-12 11:46:04 +01001116// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
1117#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1118#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1119#endif
1120
Damien George57e99eb2014-04-10 22:42:11 +01001121// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +01001122#ifndef MICROPY_PORT_CONSTANTS
1123#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +01001124#endif
1125
Damien Georgeb4b10fd2015-01-01 23:30:53 +00001126// Any root pointers for GC scanning - see mpstate.c
1127#ifndef MICROPY_PORT_ROOT_POINTERS
1128#define MICROPY_PORT_ROOT_POINTERS
1129#endif
1130
Damien George136f6752014-01-07 14:54:15 +00001131/*****************************************************************************/
1132/* Miscellaneous settings */
1133
Damien George28631532015-02-08 13:42:00 +00001134// All uPy objects in ROM must be aligned on at least a 4 byte boundary
1135// so that the small-int/qstr/pointer distinction can be made. For machines
1136// that don't do this (eg 16-bit CPU), define the following macro to something
1137// like __attribute__((aligned(4))).
1138#ifndef MICROPY_OBJ_BASE_ALIGNMENT
1139#define MICROPY_OBJ_BASE_ALIGNMENT
1140#endif
1141
Dave Hylands5b7fd202014-07-01 23:46:53 -07001142// On embedded platforms, these will typically enable/disable irqs.
1143#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001144#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001145#endif
1146#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001147#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001148#endif
1149
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +02001150// Allow to override static modifier for global objects, e.g. to use with
1151// object code analysis tools which don't support static symbols.
1152#ifndef STATIC
1153#define STATIC static
1154#endif
1155
Damien George4c307bf2017-04-01 11:39:38 +11001156// Number of bytes in a word
1157#ifndef BYTES_PER_WORD
1158#define BYTES_PER_WORD (sizeof(mp_uint_t))
1159#endif
1160
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001161#define BITS_PER_BYTE (8)
1162#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +01001163// mp_int_t value with most significant bit set
1164#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001165
Damien Georgea9bcd512014-10-06 13:44:59 +00001166// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
1167// defined and that they are the opposite of each other.
1168#if defined(MP_ENDIANNESS_LITTLE)
1169#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
1170#elif defined(MP_ENDIANNESS_BIG)
1171#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
1172#else
1173 // Endiannes not defined by port so try to autodetect it.
1174 #if defined(__BYTE_ORDER__)
1175 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
1176 #define MP_ENDIANNESS_LITTLE (1)
1177 #else
1178 #define MP_ENDIANNESS_LITTLE (0)
1179 #endif
Damien Georgef32498f2014-10-06 16:09:31 +00001180 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
1181 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +00001182 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
1183 #define MP_ENDIANNESS_LITTLE (0)
1184 #else
Damien George4e4772b2015-05-30 23:12:30 +01001185 #include <endian.h>
1186 #if defined(__BYTE_ORDER)
1187 #if __BYTE_ORDER == __LITTLE_ENDIAN
1188 #define MP_ENDIANNESS_LITTLE (1)
1189 #else
1190 #define MP_ENDIANNESS_LITTLE (0)
1191 #endif
1192 #else
1193 #error endianness not defined and cannot detect it
1194 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001195 #endif
1196 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +01001197#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +03001198
Damien George3c658a42014-08-24 16:28:17 +01001199// Make a pointer to RAM callable (eg set lower bit for Thumb code)
1200// (This scheme won't work if we want to mix Thumb and normal ARM code.)
1201#ifndef MICROPY_MAKE_POINTER_CALLABLE
1202#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
1203#endif
1204
Damien George7f9d1d62015-04-09 23:56:15 +01001205// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +00001206// must be somehow reachable for marking by the GC, since the native code
1207// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +02001208#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +00001209#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 +02001210#endif
1211
1212#ifndef MP_PLAT_FREE_EXEC
1213#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
1214#endif
1215
Damien George7f9d1d62015-04-09 23:56:15 +01001216// This macro is used to do all output (except when MICROPY_PY_IO is defined)
1217#ifndef MP_PLAT_PRINT_STRN
Damien George4300c7d2015-10-15 00:05:55 +01001218#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
Damien George7f9d1d62015-04-09 23:56:15 +01001219#endif
1220
Paul Sokolovsky722e5622014-09-06 19:17:23 +03001221#ifndef MP_SSIZE_MAX
1222#define MP_SSIZE_MAX SSIZE_MAX
1223#endif
1224
Damien George40f3c022014-07-03 13:25:24 +01001225// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +00001226#ifndef INT_FMT
stijn3baf6b52015-11-20 15:59:06 +01001227#if defined(__LP64__)
Damien George40f3c022014-07-03 13:25:24 +01001228// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001229#define UINT_FMT "%lu"
1230#define INT_FMT "%ld"
stijn3baf6b52015-11-20 15:59:06 +01001231#elif defined(_WIN64)
stijn0a4eb4d2015-12-18 10:20:33 +01001232#define UINT_FMT "%llu"
1233#define INT_FMT "%lld"
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001234#else
Damien George40f3c022014-07-03 13:25:24 +01001235// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001236#define UINT_FMT "%u"
1237#define INT_FMT "%d"
1238#endif
1239#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +03001240
1241// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +02001242#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +03001243#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +02001244#endif
mux5c8db482014-06-21 17:24:55 +02001245
1246// Modifier for weak functions
1247#ifndef MP_WEAK
1248#define MP_WEAK __attribute__((weak))
1249#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001250
Paul Sokolovsky0f5bf1a2016-06-15 23:52:00 +03001251// Modifier for functions which should be never inlined
1252#ifndef MP_NOINLINE
1253#define MP_NOINLINE __attribute__((noinline))
1254#endif
1255
Paul Sokolovsky1bc29112016-08-07 22:36:05 +03001256// Modifier for functions which should be always inlined
1257#ifndef MP_ALWAYSINLINE
1258#define MP_ALWAYSINLINE __attribute__((always_inline))
1259#endif
1260
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001261// Condition is likely to be true, to help branch prediction
1262#ifndef MP_LIKELY
1263#define MP_LIKELY(x) __builtin_expect((x), 1)
1264#endif
1265
1266// Condition is likely to be false, to help branch prediction
1267#ifndef MP_UNLIKELY
1268#define MP_UNLIKELY(x) __builtin_expect((x), 0)
1269#endif
Damien George9ddbe292014-12-29 01:02:19 +00001270
Alexander Steffen299bc622017-06-29 23:14:58 +02001271#endif // MICROPY_INCLUDED_PY_MPCONFIG_H