blob: ea90ec9841761e20ba4df4c2a6bbc3861fbbc301 [file] [log] [blame]
Damien George04b91472014-05-03 23:27:38 +01001/*
2 * This file is part of the Micro Python project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
Damien George9ddbe292014-12-29 01:02:19 +000026#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
35// such config, and it can be overriden using MP_CONFIGFILE preprocessor
36// 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
54// A Micro Python object is a machine word having the following form:
55// - 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
60// A Micro Python object is a machine word having the following form:
61// - 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.
Damien George8b8d1892015-11-06 23:25:10 +000076
Damien George183edef2015-10-17 23:20:57 +010077#define MICROPY_OBJ_REPR_C (2)
78
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000079// A MicroPython object is a 64-bit word having the following form (called R):
80// - seeeeeee eeeeffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff 64-bit fp, e != 0x7ff
81// - s1111111 11110000 00000000 00000000 00000000 00000000 00000000 00000000 +/- inf
82// - 01111111 11111000 00000000 00000000 00000000 00000000 00000000 00000000 normalised nan
83// - 01111111 11111101 00000000 00000000 iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int
84// - 01111111 11111110 00000000 00000000 qqqqqqqq qqqqqqqq qqqqqqqq qqqqqqq1 str
85// - 01111111 11111100 00000000 00000000 pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
86// Stored as O = R + 0x8004000000000000, retrieved as R = O - 0x8004000000000000.
87// This makes pointers have all zeros in the top 32 bits.
88// Small-ints and strs have 1 as LSB to make sure they don't look like pointers
89// to the garbage collector.
90#define MICROPY_OBJ_REPR_D (3)
91
Damien George567184e2015-03-29 14:05:46 +010092#ifndef MICROPY_OBJ_REPR
93#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
94#endif
95
96/*****************************************************************************/
Damien George66e18f02014-05-05 13:19:03 +010097/* Memory allocation policy */
98
Paul Sokolovsky75feece2015-12-03 01:40:52 +020099// Number of bytes in memory allocation/GC block. Any size allocated will be
100// rounded up to be multiples of this.
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200101#ifndef MICROPY_BYTES_PER_GC_BLOCK
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200102#define MICROPY_BYTES_PER_GC_BLOCK (4 * BYTES_PER_WORD)
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200103#endif
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200104
Damien Georgefd40a9c2015-01-01 22:04:46 +0000105// Number of words allocated (in BSS) to the GC stack (minimum is 1)
106#ifndef MICROPY_ALLOC_GC_STACK_SIZE
107#define MICROPY_ALLOC_GC_STACK_SIZE (64)
108#endif
109
Damien George5ffe1d82016-08-26 15:35:26 +1000110// Be conservative and always clear to zero newly (re)allocated memory in the GC.
111// This helps eliminate stray pointers that hold on to memory that's no longer
112// used. It decreases performance due to unnecessary memory clearing.
Colin Hogben828df542016-10-31 14:52:11 +0000113// A memory manager which always clears memory can set this to 0.
Damien George5ffe1d82016-08-26 15:35:26 +1000114// TODO Do analysis to understand why some memory is not properly cleared and
115// find a more efficient way to clear it.
116#ifndef MICROPY_GC_CONSERVATIVE_CLEAR
Colin Hogben828df542016-10-31 14:52:11 +0000117#define MICROPY_GC_CONSERVATIVE_CLEAR (MICROPY_ENABLE_GC)
Damien George5ffe1d82016-08-26 15:35:26 +1000118#endif
119
Paul Sokolovsky93e353e2016-07-21 00:37:30 +0300120// Support automatic GC when reaching allocation threshold,
121// configurable by gc.threshold().
122#ifndef MICROPY_GC_ALLOC_THRESHOLD
123#define MICROPY_GC_ALLOC_THRESHOLD (1)
124#endif
125
Damien Georgeade9a052015-06-13 21:53:22 +0100126// Number of bytes to allocate initially when creating new chunks to store
127// interned string data. Smaller numbers lead to more chunks being needed
128// and more wastage at the end of the chunk. Larger numbers lead to wasted
129// space at the end when no more strings need interning.
130#ifndef MICROPY_ALLOC_QSTR_CHUNK_INIT
131#define MICROPY_ALLOC_QSTR_CHUNK_INIT (128)
132#endif
133
Damien Georgee1199ec2014-05-10 17:48:01 +0100134// Initial amount for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100135#ifndef MICROPY_ALLOC_LEXER_INDENT_INIT
136#define MICROPY_ALLOC_LEXER_INDENT_INIT (10)
Damien Georgee1199ec2014-05-10 17:48:01 +0100137#endif
138
139// Increment for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100140#ifndef MICROPY_ALLOC_LEXEL_INDENT_INC
141#define MICROPY_ALLOC_LEXEL_INDENT_INC (8)
Damien Georgee1199ec2014-05-10 17:48:01 +0100142#endif
143
Damien George66e18f02014-05-05 13:19:03 +0100144// Initial amount for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100145#ifndef MICROPY_ALLOC_PARSE_RULE_INIT
146#define MICROPY_ALLOC_PARSE_RULE_INIT (64)
Damien George66e18f02014-05-05 13:19:03 +0100147#endif
148
149// Increment for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100150#ifndef MICROPY_ALLOC_PARSE_RULE_INC
151#define MICROPY_ALLOC_PARSE_RULE_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100152#endif
153
154// Initial amount for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100155#ifndef MICROPY_ALLOC_PARSE_RESULT_INIT
156#define MICROPY_ALLOC_PARSE_RESULT_INIT (32)
Damien George66e18f02014-05-05 13:19:03 +0100157#endif
158
159// Increment for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100160#ifndef MICROPY_ALLOC_PARSE_RESULT_INC
161#define MICROPY_ALLOC_PARSE_RESULT_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100162#endif
163
Damien George5042bce2014-05-25 22:06:06 +0100164// Strings this length or less will be interned by the parser
165#ifndef MICROPY_ALLOC_PARSE_INTERN_STRING_LEN
166#define MICROPY_ALLOC_PARSE_INTERN_STRING_LEN (10)
167#endif
168
Damien George58e0f4a2015-09-23 10:50:43 +0100169// Number of bytes to allocate initially when creating new chunks to store
170// parse nodes. Small leads to fragmentation, large leads to excess use.
171#ifndef MICROPY_ALLOC_PARSE_CHUNK_INIT
172#define MICROPY_ALLOC_PARSE_CHUNK_INIT (128)
173#endif
174
Damien George66e18f02014-05-05 13:19:03 +0100175// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100176#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
177#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100178#endif
179
180// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100181#ifndef MICROPY_ALLOC_SCOPE_ID_INC
182#define MICROPY_ALLOC_SCOPE_ID_INC (6)
183#endif
184
185// Maximum length of a path in the filesystem
186// So we can allocate a buffer on the stack for path manipulation in import
187#ifndef MICROPY_ALLOC_PATH_MAX
188#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100189#endif
190
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200191// Initial size of module dict
192#ifndef MICROPY_MODULE_DICT_SIZE
193#define MICROPY_MODULE_DICT_SIZE (1)
194#endif
195
Damien Georged8914522015-02-27 09:54:12 +0000196// Whether realloc/free should be passed allocated memory region size
197// You must enable this if MICROPY_MEM_STATS is enabled
198#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
199#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
200#endif
201
Damien George95836f82015-01-11 22:27:30 +0000202// Number of bytes used to store qstr length
203// Dictates hard limit on maximum Python identifier length, but 1 byte
204// (limit of 255 bytes in an identifier) should be enough for everyone
205#ifndef MICROPY_QSTR_BYTES_IN_LEN
206#define MICROPY_QSTR_BYTES_IN_LEN (1)
207#endif
208
Damien Georgec3bd9412015-07-20 11:03:13 +0000209// Number of bytes used to store qstr hash
210#ifndef MICROPY_QSTR_BYTES_IN_HASH
211#define MICROPY_QSTR_BYTES_IN_HASH (2)
212#endif
213
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200214// Avoid using C stack when making Python function calls. C stack still
215// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200216#ifndef MICROPY_STACKLESS
217#define MICROPY_STACKLESS (0)
218#endif
219
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200220// Never use C stack when making Python function calls. This may break
221// testsuite as will subtly change which exception is thrown in case
222// of too deep recursion and other similar cases.
223#ifndef MICROPY_STACKLESS_STRICT
224#define MICROPY_STACKLESS_STRICT (0)
225#endif
226
Paul Sokolovskyf32020e2015-11-25 23:22:31 +0200227// Don't use alloca calls. As alloca() is not part of ANSI C, this
228// workaround option is provided for compilers lacking this de-facto
229// standard function. The way it works is allocating from heap, and
230// relying on garbage collection to free it eventually. This is of
231// course much less optimal than real alloca().
232#if defined(MICROPY_NO_ALLOCA) && MICROPY_NO_ALLOCA
233#undef alloca
234#define alloca(x) m_malloc(x)
235#endif
236
Damien George66e18f02014-05-05 13:19:03 +0100237/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000238/* Micro Python emitters */
239
Damien Georged8c834c2015-11-02 21:55:42 +0000240// Whether to support loading of persistent code
241#ifndef MICROPY_PERSISTENT_CODE_LOAD
242#define MICROPY_PERSISTENT_CODE_LOAD (0)
243#endif
244
245// Whether to support saving of persistent code
246#ifndef MICROPY_PERSISTENT_CODE_SAVE
247#define MICROPY_PERSISTENT_CODE_SAVE (0)
248#endif
249
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000250// Whether generated code can persist independently of the VM/runtime instance
Damien Georged8c834c2015-11-02 21:55:42 +0000251// This is enabled automatically when needed by other features
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000252#ifndef MICROPY_PERSISTENT_CODE
Damien George0a2e9652016-01-31 22:24:16 +0000253#define MICROPY_PERSISTENT_CODE (MICROPY_PERSISTENT_CODE_LOAD || MICROPY_PERSISTENT_CODE_SAVE || MICROPY_MODULE_FROZEN_MPY)
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000254#endif
255
Damien George136f6752014-01-07 14:54:15 +0000256// Whether to emit x64 native code
257#ifndef MICROPY_EMIT_X64
258#define MICROPY_EMIT_X64 (0)
259#endif
260
Damien Georgec90f59e2014-09-06 23:06:36 +0100261// Whether to emit x86 native code
262#ifndef MICROPY_EMIT_X86
263#define MICROPY_EMIT_X86 (0)
264#endif
265
Damien George136f6752014-01-07 14:54:15 +0000266// Whether to emit thumb native code
267#ifndef MICROPY_EMIT_THUMB
268#define MICROPY_EMIT_THUMB (0)
269#endif
270
271// Whether to enable the thumb inline assembler
272#ifndef MICROPY_EMIT_INLINE_THUMB
273#define MICROPY_EMIT_INLINE_THUMB (0)
274#endif
275
Damien Georgee8135412015-10-16 22:08:57 +0100276// Whether to enable ARMv7-M instruction support in the Thumb2 inline assembler
277#ifndef MICROPY_EMIT_INLINE_THUMB_ARMV7M
278#define MICROPY_EMIT_INLINE_THUMB_ARMV7M (1)
279#endif
280
=50089722015-04-14 13:14:57 +0100281// Whether to enable float support in the Thumb2 inline assembler
282#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
283#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
284#endif
285
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200286// Whether to emit ARM native code
287#ifndef MICROPY_EMIT_ARM
288#define MICROPY_EMIT_ARM (0)
289#endif
290
Damien George8e5aced2016-12-09 16:39:39 +1100291// Whether to emit Xtensa native code
292#ifndef MICROPY_EMIT_XTENSA
293#define MICROPY_EMIT_XTENSA (0)
294#endif
295
Damien Georgef76b1bf2016-12-09 17:03:33 +1100296// Whether to enable the Xtensa inline assembler
297#ifndef MICROPY_EMIT_INLINE_XTENSA
298#define MICROPY_EMIT_INLINE_XTENSA (0)
299#endif
300
Damien George2ac4af62014-08-15 16:45:41 +0100301// Convenience definition for whether any native emitter is enabled
Damien George8e5aced2016-12-09 16:39:39 +1100302#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 +0100303
Damien Georgead297a12016-12-09 13:17:49 +1100304// Convenience definition for whether any inline assembler emitter is enabled
Damien Georgef76b1bf2016-12-09 17:03:33 +1100305#define MICROPY_EMIT_INLINE_ASM (MICROPY_EMIT_INLINE_THUMB || MICROPY_EMIT_INLINE_XTENSA)
Damien Georgead297a12016-12-09 13:17:49 +1100306
Damien George136f6752014-01-07 14:54:15 +0000307/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100308/* Compiler configuration */
309
Damien Georgedd5353a2015-12-18 12:35:44 +0000310// Whether to include the compiler
311#ifndef MICROPY_ENABLE_COMPILER
312#define MICROPY_ENABLE_COMPILER (1)
313#endif
314
Damien Georgeea235202016-02-11 22:30:53 +0000315// Whether the compiler is dynamically configurable (ie at runtime)
316#ifndef MICROPY_DYNAMIC_COMPILER
317#define MICROPY_DYNAMIC_COMPILER (0)
318#endif
319
320// Configure dynamic compiler macros
321#if MICROPY_DYNAMIC_COMPILER
322#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE_DYNAMIC (mp_dynamic_compiler.opt_cache_map_lookup_in_bytecode)
323#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC (mp_dynamic_compiler.py_builtins_str_unicode)
324#else
325#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE_DYNAMIC MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
326#define MICROPY_PY_BUILTINS_STR_UNICODE_DYNAMIC MICROPY_PY_BUILTINS_STR_UNICODE
327#endif
328
Damien George64f2b212015-10-08 14:58:15 +0100329// Whether to enable constant folding; eg 1+2 rewritten as 3
330#ifndef MICROPY_COMP_CONST_FOLDING
331#define MICROPY_COMP_CONST_FOLDING (1)
332#endif
333
Damien Georgeddd1e182015-01-10 14:07:24 +0000334// Whether to enable lookup of constants in modules; eg module.CONST
335#ifndef MICROPY_COMP_MODULE_CONST
336#define MICROPY_COMP_MODULE_CONST (0)
337#endif
338
Damien George58ebde42014-05-21 20:32:59 +0100339// Whether to enable constant optimisation; id = const(value)
340#ifndef MICROPY_COMP_CONST
341#define MICROPY_COMP_CONST (1)
342#endif
343
Damien George42e0c592015-03-14 13:11:35 +0000344// Whether to enable optimisation of: a, b = c, d
345// Costs 124 bytes (Thumb2)
346#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
347#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
348#endif
349
350// Whether to enable optimisation of: a, b, c = d, e, f
351// Cost 156 bytes (Thumb2)
352#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
353#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
354#endif
355
Damien George58ebde42014-05-21 20:32:59 +0100356/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000357/* Internal debugging stuff */
358
359// Whether to collect memory allocation stats
360#ifndef MICROPY_MEM_STATS
361#define MICROPY_MEM_STATS (0)
362#endif
363
Damien Georgecbd2f742014-01-19 11:48:48 +0000364// Whether to build functions that print debugging info:
nhtshot5d323de2015-02-23 15:05:32 -0600365// mp_lexer_show_token
Damien George3417bc22014-05-10 10:36:38 +0100366// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000367// mp_parse_node_print
368#ifndef MICROPY_DEBUG_PRINTERS
369#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000370#endif
371
Damien George136f6752014-01-07 14:54:15 +0000372/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100373/* Optimisations */
374
375// Whether to use computed gotos in the VM, or a switch
376// Computed gotos are roughly 10% faster, and increase VM code size by a little
377#ifndef MICROPY_OPT_COMPUTED_GOTO
378#define MICROPY_OPT_COMPUTED_GOTO (0)
379#endif
380
Damien George7ee91cf2015-01-06 12:51:39 +0000381// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
382// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
383// uses a bit of extra code ROM, but greatly improves lookup speed.
384#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
385#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
386#endif
387
Doug Currie2e2e15c2016-01-30 22:35:58 -0500388// Whether to use fast versions of bitwise operations (and, or, xor) when the
389// arguments are both positive. Increases Thumb2 code size by about 250 bytes.
390#ifndef MICROPY_OPT_MPZ_BITWISE
391#define MICROPY_OPT_MPZ_BITWISE (0)
392#endif
393
Damien Georgeee3fd462014-05-24 23:03:12 +0100394/*****************************************************************************/
395/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000396
Damien George6b239c22016-11-16 16:04:57 +1100397// Whether to use the POSIX reader for importing files
398#ifndef MICROPY_READER_POSIX
399#define MICROPY_READER_POSIX (0)
400#endif
401
402// Whether to use the FatFS reader for importing files
403#ifndef MICROPY_READER_FATFS
404#define MICROPY_READER_FATFS (0)
405#endif
406
Damien George40d84302016-02-15 22:46:21 +0000407// Hook for the VM at the start of the opcode loop (can contain variable
408// definitions usable by the other hook functions)
409#ifndef MICROPY_VM_HOOK_INIT
410#define MICROPY_VM_HOOK_INIT
411#endif
412
413// Hook for the VM during the opcode loop (but only after jump opcodes)
414#ifndef MICROPY_VM_HOOK_LOOP
415#define MICROPY_VM_HOOK_LOOP
416#endif
417
418// Hook for the VM just before return opcode is finished being interpreted
419#ifndef MICROPY_VM_HOOK_RETURN
420#define MICROPY_VM_HOOK_RETURN
421#endif
422
Damien Georged3ebe482014-01-07 15:20:33 +0000423// Whether to include the garbage collector
424#ifndef MICROPY_ENABLE_GC
425#define MICROPY_ENABLE_GC (0)
426#endif
427
Damien George12bab722014-04-05 20:35:48 +0100428// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000429#ifndef MICROPY_ENABLE_FINALISER
430#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100431#endif
432
Paul Sokolovsky23668692014-06-25 03:03:34 +0300433// Whether to check C stack usage. C stack used for calling Python functions,
434// etc. Not checking means segfault on overflow.
435#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000436#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300437#endif
438
Dave Hylands5b7fd202014-07-01 23:46:53 -0700439// Whether to have an emergency exception buffer
440#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
441#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
442#endif
443#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
444# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
445# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
446# endif
447#endif
448
Paul Sokolovsky1c9210b2015-12-23 00:06:37 +0200449// Prefer to raise KeyboardInterrupt asynchronously (from signal or interrupt
450// handler) - if supported by a particular port.
451#ifndef MICROPY_ASYNC_KBD_INTR
452#define MICROPY_ASYNC_KBD_INTR (0)
453#endif
454
Damien George136f6752014-01-07 14:54:15 +0000455// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100456#ifndef MICROPY_HELPER_REPL
457#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000458#endif
459
Tom Soulanille7d588b02015-07-09 16:32:36 -0700460// Whether to include emacs-style readline behavior in REPL
461#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100462#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700463#endif
464
Damien George0af73012015-08-20 10:34:16 +0100465// Whether to implement auto-indent in REPL
466#ifndef MICROPY_REPL_AUTO_INDENT
467#define MICROPY_REPL_AUTO_INDENT (0)
468#endif
469
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200470// Whether port requires event-driven REPL functions
471#ifndef MICROPY_REPL_EVENT_DRIVEN
472#define MICROPY_REPL_EVENT_DRIVEN (0)
473#endif
474
Damien Georged3ebe482014-01-07 15:20:33 +0000475// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100476#ifndef MICROPY_HELPER_LEXER_UNIX
477#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000478#endif
479
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200480// Long int implementation
481#define MICROPY_LONGINT_IMPL_NONE (0)
482#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000483#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200484
485#ifndef MICROPY_LONGINT_IMPL
486#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
487#endif
488
489#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
490typedef long long mp_longint_impl_t;
491#endif
492
Damien George62ad1892014-01-29 21:51:51 +0000493// Whether to include information in the byte code to determine source
494// line number (increases RAM usage, but doesn't slow byte code execution)
495#ifndef MICROPY_ENABLE_SOURCE_LINE
496#define MICROPY_ENABLE_SOURCE_LINE (0)
497#endif
498
Damien George1463c1f2014-04-25 23:52:57 +0100499// Whether to include doc strings (increases RAM usage)
500#ifndef MICROPY_ENABLE_DOC_STRING
501#define MICROPY_ENABLE_DOC_STRING (0)
502#endif
503
Damien George1e9a92f2014-11-06 17:36:16 +0000504// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300505#define MICROPY_ERROR_REPORTING_TERSE (1)
506// Exception messages provide basic error details
507#define MICROPY_ERROR_REPORTING_NORMAL (2)
508// Exception messages provide full info, e.g. object names
509#define MICROPY_ERROR_REPORTING_DETAILED (3)
510
511#ifndef MICROPY_ERROR_REPORTING
512#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
513#endif
514
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200515// Whether issue warnings during compiling/execution
516#ifndef MICROPY_WARNINGS
517#define MICROPY_WARNINGS (0)
518#endif
519
Damien George0c36da02014-03-08 15:24:39 +0000520// Float and complex implementation
521#define MICROPY_FLOAT_IMPL_NONE (0)
522#define MICROPY_FLOAT_IMPL_FLOAT (1)
523#define MICROPY_FLOAT_IMPL_DOUBLE (2)
524
525#ifndef MICROPY_FLOAT_IMPL
526#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
527#endif
528
529#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100530#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100531#define MICROPY_FLOAT_CONST(x) x##F
Damien George0c36da02014-03-08 15:24:39 +0000532#define MICROPY_FLOAT_C_FUN(fun) fun##f
533typedef float mp_float_t;
534#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100535#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George561844f2016-11-03 12:33:01 +1100536#define MICROPY_FLOAT_CONST(x) x
Damien George0c36da02014-03-08 15:24:39 +0000537#define MICROPY_FLOAT_C_FUN(fun) fun
538typedef double mp_float_t;
539#else
Damien Georgefb510b32014-06-01 13:32:54 +0100540#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000541#endif
542
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300543#ifndef MICROPY_PY_BUILTINS_COMPLEX
544#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
545#endif
546
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200547// Enable features which improve CPython compatibility
548// but may lead to more code size/memory usage.
549// TODO: Originally intended as generic category to not
550// add bunch of once-off options. May need refactoring later
551#ifndef MICROPY_CPYTHON_COMPAT
552#define MICROPY_CPYTHON_COMPAT (1)
553#endif
554
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300555// Whether POSIX-semantics non-blocking streams are supported
556#ifndef MICROPY_STREAMS_NON_BLOCK
557#define MICROPY_STREAMS_NON_BLOCK (0)
558#endif
559
Paul Sokolovsky61e77a42016-07-30 20:05:56 +0300560// Whether to provide stream functions with POSIX-like signatures
561// (useful for porting existing libraries to MicroPython).
562#ifndef MICROPY_STREAMS_POSIX_API
563#define MICROPY_STREAMS_POSIX_API (0)
564#endif
565
Damien George3c9c3682015-09-15 14:56:13 +0100566// Whether to call __init__ when importing builtin modules for the first time
567#ifndef MICROPY_MODULE_BUILTIN_INIT
568#define MICROPY_MODULE_BUILTIN_INIT (0)
569#endif
570
Damien Georgec14a8162014-10-12 11:46:04 +0100571// Whether module weak links are supported
572#ifndef MICROPY_MODULE_WEAK_LINKS
573#define MICROPY_MODULE_WEAK_LINKS (0)
574#endif
575
Damien George0a2e9652016-01-31 22:24:16 +0000576// Whether frozen modules are supported in the form of strings
577#ifndef MICROPY_MODULE_FROZEN_STR
578#define MICROPY_MODULE_FROZEN_STR (0)
579#endif
580
581// Whether frozen modules are supported in the form of .mpy files
582#ifndef MICROPY_MODULE_FROZEN_MPY
583#define MICROPY_MODULE_FROZEN_MPY (0)
584#endif
585
586// Convenience macro for whether frozen modules are supported
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200587#ifndef MICROPY_MODULE_FROZEN
Damien George0a2e9652016-01-31 22:24:16 +0000588#define MICROPY_MODULE_FROZEN (MICROPY_MODULE_FROZEN_STR || MICROPY_MODULE_FROZEN_MPY)
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200589#endif
590
Damien George78d702c2014-12-09 16:19:48 +0000591// Whether you can override builtins in the builtins module
592#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
593#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
594#endif
595
Damien George06593fb2015-06-19 12:49:10 +0000596// Whether to check that the "self" argument of a builtin method has the
597// correct type. Such an explicit check is only needed if a builtin
598// method escapes to Python land without a first argument, eg
599// list.append([], 1). Without this check such calls will have undefined
600// behaviour (usually segfault) if the first argument is the wrong type.
601#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
602#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
603#endif
604
Damien George3f56fd62016-05-10 10:54:06 +0100605// Whether to use internally defined errno's (otherwise system provided ones)
606#ifndef MICROPY_USE_INTERNAL_ERRNO
607#define MICROPY_USE_INTERNAL_ERRNO (0)
608#endif
609
Delio Brignolie2ac8bb2016-08-21 11:33:37 +0200610// Whether to use internally defined *printf() functions (otherwise external ones)
611#ifndef MICROPY_USE_INTERNAL_PRINTF
612#define MICROPY_USE_INTERNAL_PRINTF (1)
613#endif
614
Paul Sokolovskyf0fbab72015-11-25 00:43:11 +0200615// Support for user-space VFS mount (selected ports)
616#ifndef MICROPY_FSUSERMOUNT
617#define MICROPY_FSUSERMOUNT (0)
618#endif
619
Damien Georgeee3fd462014-05-24 23:03:12 +0100620/*****************************************************************************/
621/* Fine control over Python builtins, classes, modules, etc */
622
stijn3cc17c62015-02-14 18:44:31 +0100623// Whether to implement attributes on functions
624#ifndef MICROPY_PY_FUNCTION_ATTRS
625#define MICROPY_PY_FUNCTION_ATTRS (0)
626#endif
627
stijn28fa84b2015-02-14 18:43:54 +0100628// Whether to support descriptors (__get__ and __set__)
629// This costs some code size and makes all load attrs and store attrs slow
630#ifndef MICROPY_PY_DESCRIPTORS
631#define MICROPY_PY_DESCRIPTORS (0)
632#endif
633
pohmelie81ebba72016-01-27 23:23:11 +0300634// Support for async/await/async for/async with
635#ifndef MICROPY_PY_ASYNC_AWAIT
636#define MICROPY_PY_ASYNC_AWAIT (1)
637#endif
638
Paul Sokolovskya1b442b2016-07-22 00:46:24 +0300639// Issue a warning when comparing str and bytes objects
Paul Sokolovsky707cae72016-07-22 00:34:34 +0300640#ifndef MICROPY_PY_STR_BYTES_CMP_WARN
641#define MICROPY_PY_STR_BYTES_CMP_WARN (0)
642#endif
643
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300644// Whether str object is proper unicode
645#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
646#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100647#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100648
Paul Sokolovsky1b5abfc2016-05-22 00:13:44 +0300649// Whether str.center() method provided
650#ifndef MICROPY_PY_BUILTINS_STR_CENTER
651#define MICROPY_PY_BUILTINS_STR_CENTER (0)
652#endif
653
Paul Sokolovsky56eb25f2016-08-07 06:46:55 +0300654// Whether str.partition()/str.rpartition() method provided
655#ifndef MICROPY_PY_BUILTINS_STR_PARTITION
656#define MICROPY_PY_BUILTINS_STR_PARTITION (0)
657#endif
658
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300659// Whether str.splitlines() method provided
660#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
661#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
662#endif
663
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300664// Whether to support bytearray object
665#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
666#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300667#endif
668
Damien Georgedd4f4532014-10-23 13:34:35 +0100669// Whether to support memoryview object
670#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
671#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
672#endif
673
Damien George3ebd4d02014-06-01 13:46:47 +0100674// Whether to support set object
675#ifndef MICROPY_PY_BUILTINS_SET
676#define MICROPY_PY_BUILTINS_SET (1)
677#endif
678
Damien Georgefb510b32014-06-01 13:32:54 +0100679// Whether to support slice subscript operators and slice object
680#ifndef MICROPY_PY_BUILTINS_SLICE
681#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100682#endif
683
Tom Soulanilleaeb62f92015-09-11 14:31:32 -0700684// Whether to support slice attribute read access,
685// i.e. slice.start, slice.stop, slice.step
686#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
687#define MICROPY_PY_BUILTINS_SLICE_ATTRS (0)
688#endif
689
Damien Georgeee3fd462014-05-24 23:03:12 +0100690// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100691#ifndef MICROPY_PY_BUILTINS_FROZENSET
692#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100693#endif
694
Damien Georgefb510b32014-06-01 13:32:54 +0100695// Whether to support property object
696#ifndef MICROPY_PY_BUILTINS_PROPERTY
697#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100698#endif
699
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500700// Whether to implement the start/stop/step attributes (readback) on
701// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
702#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
703#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
704#endif
705
Daniel Campora077812b2015-06-29 22:45:39 +0200706// Whether to support timeout exceptions (like socket.timeout)
707#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
708#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
709#endif
710
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200711// Whether to support complete set of special methods
712// for user classes, otherwise only the most used
713#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
714#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
715#endif
716
Damien Georgec9fc6202014-10-25 21:59:14 +0100717// Whether to support compile function
718#ifndef MICROPY_PY_BUILTINS_COMPILE
719#define MICROPY_PY_BUILTINS_COMPILE (0)
720#endif
721
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300722// Whether to support enumerate function(type)
723#ifndef MICROPY_PY_BUILTINS_ENUMERATE
724#define MICROPY_PY_BUILTINS_ENUMERATE (1)
725#endif
726
Damien Georgedd5353a2015-12-18 12:35:44 +0000727// Whether to support eval and exec functions
728// By default they are supported if the compiler is enabled
729#ifndef MICROPY_PY_BUILTINS_EVAL_EXEC
730#define MICROPY_PY_BUILTINS_EVAL_EXEC (MICROPY_ENABLE_COMPILER)
731#endif
732
Damien George2a3e2b92014-12-19 13:36:17 +0000733// Whether to support the Python 2 execfile function
734#ifndef MICROPY_PY_BUILTINS_EXECFILE
735#define MICROPY_PY_BUILTINS_EXECFILE (0)
736#endif
737
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300738// Whether to support filter function(type)
739#ifndef MICROPY_PY_BUILTINS_FILTER
740#define MICROPY_PY_BUILTINS_FILTER (1)
741#endif
742
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300743// Whether to support reversed function(type)
744#ifndef MICROPY_PY_BUILTINS_REVERSED
745#define MICROPY_PY_BUILTINS_REVERSED (1)
746#endif
747
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300748// Whether to define "NotImplemented" special constant
749#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
750#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
751#endif
752
pohmelie354e6882015-12-07 15:35:48 +0300753// Whether to support min/max functions
754#ifndef MICROPY_PY_BUILTINS_MIN_MAX
755#define MICROPY_PY_BUILTINS_MIN_MAX (1)
756#endif
757
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300758// Whether to set __file__ for imported modules
759#ifndef MICROPY_PY___FILE__
760#define MICROPY_PY___FILE__ (1)
761#endif
762
Damien George89deec02015-01-09 20:12:54 +0000763// Whether to provide mem-info related functions in micropython module
764#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
765#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
766#endif
767
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300768// Whether to provide "array" module. Note that large chunk of the
769// underlying code is shared with "bytearray" builtin type, so to
770// get real savings, it should be disabled too.
771#ifndef MICROPY_PY_ARRAY
772#define MICROPY_PY_ARRAY (1)
773#endif
774
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200775// Whether to support slice assignments for array (and bytearray).
776// This is rarely used, but adds ~0.5K of code.
777#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
778#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
779#endif
780
Damien George5aa311d2015-04-21 14:14:24 +0000781// Whether to support attrtuple type (MicroPython extension)
782// It provides space-efficient tuples with attribute access
783#ifndef MICROPY_PY_ATTRTUPLE
784#define MICROPY_PY_ATTRTUPLE (1)
785#endif
786
Damien Georgeee3fd462014-05-24 23:03:12 +0100787// Whether to provide "collections" module
788#ifndef MICROPY_PY_COLLECTIONS
789#define MICROPY_PY_COLLECTIONS (1)
790#endif
791
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200792// Whether to provide "collections.OrderedDict" type
793#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
794#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
795#endif
796
Damien Georgeee3fd462014-05-24 23:03:12 +0100797// Whether to provide "math" module
798#ifndef MICROPY_PY_MATH
799#define MICROPY_PY_MATH (1)
800#endif
801
Damien George5cbeace2015-02-22 14:48:18 +0000802// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
803#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
804#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
805#endif
806
Damien Georgeee3fd462014-05-24 23:03:12 +0100807// Whether to provide "cmath" module
808#ifndef MICROPY_PY_CMATH
809#define MICROPY_PY_CMATH (0)
810#endif
811
812// Whether to provide "gc" module
813#ifndef MICROPY_PY_GC
814#define MICROPY_PY_GC (1)
815#endif
816
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300817// Whether to return number of collected objects from gc.collect()
818#ifndef MICROPY_PY_GC_COLLECT_RETVAL
819#define MICROPY_PY_GC_COLLECT_RETVAL (0)
820#endif
821
Damien Georgeee3fd462014-05-24 23:03:12 +0100822// Whether to provide "io" module
823#ifndef MICROPY_PY_IO
824#define MICROPY_PY_IO (1)
825#endif
826
827// Whether to provide "io.FileIO" class
828#ifndef MICROPY_PY_IO_FILEIO
829#define MICROPY_PY_IO_FILEIO (0)
830#endif
831
832// Whether to provide "io.BytesIO" class
833#ifndef MICROPY_PY_IO_BYTESIO
834#define MICROPY_PY_IO_BYTESIO (1)
835#endif
836
Paul Sokolovsky5d93dfb2016-03-25 01:10:49 +0200837// Whether to provide "io.BufferedWriter" class
838#ifndef MICROPY_PY_IO_BUFFEREDWRITER
839#define MICROPY_PY_IO_BUFFEREDWRITER (0)
840#endif
841
Damien Georgeee3fd462014-05-24 23:03:12 +0100842// Whether to provide "struct" module
843#ifndef MICROPY_PY_STRUCT
844#define MICROPY_PY_STRUCT (1)
845#endif
846
847// Whether to provide "sys" module
848#ifndef MICROPY_PY_SYS
849#define MICROPY_PY_SYS (1)
850#endif
851
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300852// Whether to provide "sys.maxsize" constant
853#ifndef MICROPY_PY_SYS_MAXSIZE
854#define MICROPY_PY_SYS_MAXSIZE (0)
855#endif
856
Paul Sokolovsky1a1d11f2015-12-05 00:09:10 +0200857// Whether to provide "sys.modules" dictionary
858#ifndef MICROPY_PY_SYS_MODULES
859#define MICROPY_PY_SYS_MODULES (1)
860#endif
861
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300862// Whether to provide "sys.exc_info" function
863// Avoid enabling this, this function is Python2 heritage
864#ifndef MICROPY_PY_SYS_EXC_INFO
865#define MICROPY_PY_SYS_EXC_INFO (0)
866#endif
867
Damien Georgeee3fd462014-05-24 23:03:12 +0100868// Whether to provide "sys.exit" function
869#ifndef MICROPY_PY_SYS_EXIT
Paul Sokolovsky403c9302016-12-14 21:10:22 +0300870#define MICROPY_PY_SYS_EXIT (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100871#endif
872
873// Whether to provide sys.{stdin,stdout,stderr} objects
874#ifndef MICROPY_PY_SYS_STDFILES
875#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100876#endif
877
Damien George3c4b5d42015-05-13 23:49:21 +0100878// Whether to provide sys.{stdin,stdout,stderr}.buffer object
879// This is implemented per-port
880#ifndef MICROPY_PY_SYS_STDIO_BUFFER
881#define MICROPY_PY_SYS_STDIO_BUFFER (0)
882#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300883
Damien George596a3fe2016-05-10 10:54:25 +0100884// Whether to provide "uerrno" module
885#ifndef MICROPY_PY_UERRNO
886#define MICROPY_PY_UERRNO (0)
887#endif
888
Paul Sokolovsky8f5bc3f2016-11-20 23:49:45 +0300889// Whether to provide "uselect" module (baremetal implementation)
890#ifndef MICROPY_PY_USELECT
891#define MICROPY_PY_USELECT (0)
892#endif
893
Paul Sokolovskya9728442016-10-14 20:13:02 +0300894// Whether to provide "utime" module functions implementation
895// in terms of mp_hal_* functions.
896#ifndef MICROPY_PY_UTIME_MP_HAL
897#define MICROPY_PY_UTIME_MP_HAL (0)
898#endif
899
Paul Sokolovsky76146b32016-10-30 03:02:07 +0300900// Period of values returned by utime.ticks_ms(), ticks_us(), ticks_cpu()
901// functions. Should be power of two. All functions above use the same
902// period, so if underlying hardware/API has different periods, the
903// minimum of them should be used. The value below is the maximum value
904// this parameter can take (corresponding to 30 bit tick values on 32-bit
905// system).
906#ifndef MICROPY_PY_UTIME_TICKS_PERIOD
907#define MICROPY_PY_UTIME_TICKS_PERIOD (MP_SMALL_INT_POSITIVE_MASK + 1)
908#endif
909
Damien George27cc0772016-04-22 22:52:33 +0000910// Whether to provide "_thread" module
911#ifndef MICROPY_PY_THREAD
912#define MICROPY_PY_THREAD (0)
913#endif
914
Damien George4cec63a2016-05-26 10:42:53 +0000915// Whether to make the VM/runtime thread-safe using a global lock
916// If not enabled then thread safety must be provided at the Python level
917#ifndef MICROPY_PY_THREAD_GIL
918#define MICROPY_PY_THREAD_GIL (MICROPY_PY_THREAD)
919#endif
920
Paul Sokolovsky82158472014-06-28 03:03:47 +0300921// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +0300922
Paul Sokolovsky82158472014-06-28 03:03:47 +0300923#ifndef MICROPY_PY_UCTYPES
924#define MICROPY_PY_UCTYPES (0)
925#endif
926
Paul Sokolovsky34162872014-10-12 08:16:34 -0700927#ifndef MICROPY_PY_UZLIB
928#define MICROPY_PY_UZLIB (0)
929#endif
930
Damien George612045f2014-09-17 22:56:34 +0100931#ifndef MICROPY_PY_UJSON
932#define MICROPY_PY_UJSON (0)
933#endif
934
Paul Sokolovskyc71e0452014-09-12 18:48:07 +0300935#ifndef MICROPY_PY_URE
936#define MICROPY_PY_URE (0)
937#endif
938
Damien Georgef5d69792014-10-22 17:37:18 +0000939#ifndef MICROPY_PY_UHEAPQ
940#define MICROPY_PY_UHEAPQ (0)
941#endif
942
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +0200943#ifndef MICROPY_PY_UHASHLIB
944#define MICROPY_PY_UHASHLIB (0)
945#endif
946
Paul Sokolovskybfdc2052014-11-29 06:19:30 +0200947#ifndef MICROPY_PY_UBINASCII
948#define MICROPY_PY_UBINASCII (0)
949#endif
950
Paul Sokolovskyc4283672016-08-24 18:28:43 +0300951// Depends on MICROPY_PY_UZLIB
952#ifndef MICROPY_PY_UBINASCII_CRC32
953#define MICROPY_PY_UBINASCII_CRC32 (0)
954#endif
955
Paul Sokolovskya58a91e2016-01-17 12:10:28 +0200956#ifndef MICROPY_PY_URANDOM
957#define MICROPY_PY_URANDOM (0)
958#endif
959
Damien Georgea53af6c2016-01-22 16:19:32 +0000960// Whether to include: randrange, randint, choice, random, uniform
961#ifndef MICROPY_PY_URANDOM_EXTRA_FUNCS
962#define MICROPY_PY_URANDOM_EXTRA_FUNCS (0)
963#endif
964
Paul Sokolovsky01162182015-05-03 20:25:40 +0300965#ifndef MICROPY_PY_MACHINE
966#define MICROPY_PY_MACHINE (0)
967#endif
968
Damien George33168082016-05-31 14:25:19 +0100969// Whether to include: time_pulse_us
970#ifndef MICROPY_PY_MACHINE_PULSE
971#define MICROPY_PY_MACHINE_PULSE (0)
972#endif
973
Damien Georged0837122016-04-12 13:42:35 +0100974#ifndef MICROPY_PY_MACHINE_I2C
975#define MICROPY_PY_MACHINE_I2C (0)
976#endif
977
Damien George0823c1b2016-09-01 15:07:20 +1000978#ifndef MICROPY_PY_MACHINE_SPI
979#define MICROPY_PY_MACHINE_SPI (0)
980#endif
981
Paul Sokolovskyaaa88672015-10-06 18:10:00 +0300982#ifndef MICROPY_PY_USSL
983#define MICROPY_PY_USSL (0)
984#endif
985
Paul Sokolovsky24342dd2016-03-24 19:14:12 +0200986#ifndef MICROPY_PY_WEBSOCKET
987#define MICROPY_PY_WEBSOCKET (0)
988#endif
989
Damien George53ad6812016-04-08 11:08:37 +0100990#ifndef MICROPY_PY_FRAMEBUF
991#define MICROPY_PY_FRAMEBUF (0)
992#endif
993
Paul Sokolovsky737bd9c2016-07-02 14:57:42 +0300994#ifndef MICROPY_PY_BTREE
995#define MICROPY_PY_BTREE (0)
996#endif
997
Damien George58ebde42014-05-21 20:32:59 +0100998/*****************************************************************************/
999/* Hooks for a port to add builtins */
1000
Damien Georgecaac5422014-03-25 14:18:18 +00001001// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001002#ifndef MICROPY_PORT_BUILTINS
1003#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +02001004#endif
Damien Georgecaac5422014-03-25 14:18:18 +00001005
1006// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +01001007#ifndef MICROPY_PORT_BUILTIN_MODULES
1008#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +00001009#endif
1010
Damien Georgec14a8162014-10-12 11:46:04 +01001011// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
1012#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1013#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
1014#endif
1015
Damien George57e99eb2014-04-10 22:42:11 +01001016// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +01001017#ifndef MICROPY_PORT_CONSTANTS
1018#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +01001019#endif
1020
Damien Georgeb4b10fd2015-01-01 23:30:53 +00001021// Any root pointers for GC scanning - see mpstate.c
1022#ifndef MICROPY_PORT_ROOT_POINTERS
1023#define MICROPY_PORT_ROOT_POINTERS
1024#endif
1025
Damien George136f6752014-01-07 14:54:15 +00001026/*****************************************************************************/
1027/* Miscellaneous settings */
1028
Damien George28631532015-02-08 13:42:00 +00001029// All uPy objects in ROM must be aligned on at least a 4 byte boundary
1030// so that the small-int/qstr/pointer distinction can be made. For machines
1031// that don't do this (eg 16-bit CPU), define the following macro to something
1032// like __attribute__((aligned(4))).
1033#ifndef MICROPY_OBJ_BASE_ALIGNMENT
1034#define MICROPY_OBJ_BASE_ALIGNMENT
1035#endif
1036
Dave Hylands5b7fd202014-07-01 23:46:53 -07001037// On embedded platforms, these will typically enable/disable irqs.
1038#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001039#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001040#endif
1041#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +00001042#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -07001043#endif
1044
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +02001045// Allow to override static modifier for global objects, e.g. to use with
1046// object code analysis tools which don't support static symbols.
1047#ifndef STATIC
1048#define STATIC static
1049#endif
1050
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001051#define BITS_PER_BYTE (8)
1052#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +01001053// mp_int_t value with most significant bit set
1054#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +02001055
Damien Georgea9bcd512014-10-06 13:44:59 +00001056// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
1057// defined and that they are the opposite of each other.
1058#if defined(MP_ENDIANNESS_LITTLE)
1059#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
1060#elif defined(MP_ENDIANNESS_BIG)
1061#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
1062#else
1063 // Endiannes not defined by port so try to autodetect it.
1064 #if defined(__BYTE_ORDER__)
1065 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
1066 #define MP_ENDIANNESS_LITTLE (1)
1067 #else
1068 #define MP_ENDIANNESS_LITTLE (0)
1069 #endif
Damien Georgef32498f2014-10-06 16:09:31 +00001070 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
1071 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +00001072 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
1073 #define MP_ENDIANNESS_LITTLE (0)
1074 #else
Damien George4e4772b2015-05-30 23:12:30 +01001075 #include <endian.h>
1076 #if defined(__BYTE_ORDER)
1077 #if __BYTE_ORDER == __LITTLE_ENDIAN
1078 #define MP_ENDIANNESS_LITTLE (1)
1079 #else
1080 #define MP_ENDIANNESS_LITTLE (0)
1081 #endif
1082 #else
1083 #error endianness not defined and cannot detect it
1084 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +00001085 #endif
1086 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +01001087#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +03001088
Damien George3c658a42014-08-24 16:28:17 +01001089// Make a pointer to RAM callable (eg set lower bit for Thumb code)
1090// (This scheme won't work if we want to mix Thumb and normal ARM code.)
1091#ifndef MICROPY_MAKE_POINTER_CALLABLE
1092#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
1093#endif
1094
Damien George7f9d1d62015-04-09 23:56:15 +01001095// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +00001096// must be somehow reachable for marking by the GC, since the native code
1097// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +02001098#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +00001099#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 +02001100#endif
1101
1102#ifndef MP_PLAT_FREE_EXEC
1103#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
1104#endif
1105
Damien George7f9d1d62015-04-09 23:56:15 +01001106// This macro is used to do all output (except when MICROPY_PY_IO is defined)
1107#ifndef MP_PLAT_PRINT_STRN
Damien George4300c7d2015-10-15 00:05:55 +01001108#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
Damien George7f9d1d62015-04-09 23:56:15 +01001109#endif
1110
Paul Sokolovsky722e5622014-09-06 19:17:23 +03001111#ifndef MP_SSIZE_MAX
1112#define MP_SSIZE_MAX SSIZE_MAX
1113#endif
1114
Damien George40f3c022014-07-03 13:25:24 +01001115// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +00001116#ifndef INT_FMT
stijn3baf6b52015-11-20 15:59:06 +01001117#if defined(__LP64__)
Damien George40f3c022014-07-03 13:25:24 +01001118// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001119#define UINT_FMT "%lu"
1120#define INT_FMT "%ld"
stijn3baf6b52015-11-20 15:59:06 +01001121#elif defined(_WIN64)
stijn0a4eb4d2015-12-18 10:20:33 +01001122#define UINT_FMT "%llu"
1123#define INT_FMT "%lld"
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001124#else
Damien George40f3c022014-07-03 13:25:24 +01001125// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +02001126#define UINT_FMT "%u"
1127#define INT_FMT "%d"
1128#endif
1129#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +03001130
1131// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +02001132#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +03001133#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +02001134#endif
mux5c8db482014-06-21 17:24:55 +02001135
1136// Modifier for weak functions
1137#ifndef MP_WEAK
1138#define MP_WEAK __attribute__((weak))
1139#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001140
Paul Sokolovsky0f5bf1a2016-06-15 23:52:00 +03001141// Modifier for functions which should be never inlined
1142#ifndef MP_NOINLINE
1143#define MP_NOINLINE __attribute__((noinline))
1144#endif
1145
Paul Sokolovsky1bc29112016-08-07 22:36:05 +03001146// Modifier for functions which should be always inlined
1147#ifndef MP_ALWAYSINLINE
1148#define MP_ALWAYSINLINE __attribute__((always_inline))
1149#endif
1150
Paul Sokolovsky361909e2014-12-29 00:51:06 +02001151// Condition is likely to be true, to help branch prediction
1152#ifndef MP_LIKELY
1153#define MP_LIKELY(x) __builtin_expect((x), 1)
1154#endif
1155
1156// Condition is likely to be false, to help branch prediction
1157#ifndef MP_UNLIKELY
1158#define MP_UNLIKELY(x) __builtin_expect((x), 0)
1159#endif
Damien George9ddbe292014-12-29 01:02:19 +00001160
1161#endif // __MICROPY_INCLUDED_PY_MPCONFIG_H__