blob: 500af5e7646e2a76e33308ff977d3684955b4896 [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
66#ifndef MICROPY_OBJ_REPR
67#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
68#endif
69
70/*****************************************************************************/
Damien George66e18f02014-05-05 13:19:03 +010071/* Memory allocation policy */
72
Damien Georgefd40a9c2015-01-01 22:04:46 +000073// Number of words allocated (in BSS) to the GC stack (minimum is 1)
74#ifndef MICROPY_ALLOC_GC_STACK_SIZE
75#define MICROPY_ALLOC_GC_STACK_SIZE (64)
76#endif
77
Damien Georgeade9a052015-06-13 21:53:22 +010078// Number of bytes to allocate initially when creating new chunks to store
79// interned string data. Smaller numbers lead to more chunks being needed
80// and more wastage at the end of the chunk. Larger numbers lead to wasted
81// space at the end when no more strings need interning.
82#ifndef MICROPY_ALLOC_QSTR_CHUNK_INIT
83#define MICROPY_ALLOC_QSTR_CHUNK_INIT (128)
84#endif
85
Damien Georgee1199ec2014-05-10 17:48:01 +010086// Initial amount for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +010087#ifndef MICROPY_ALLOC_LEXER_INDENT_INIT
88#define MICROPY_ALLOC_LEXER_INDENT_INIT (10)
Damien Georgee1199ec2014-05-10 17:48:01 +010089#endif
90
91// Increment for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +010092#ifndef MICROPY_ALLOC_LEXEL_INDENT_INC
93#define MICROPY_ALLOC_LEXEL_INDENT_INC (8)
Damien Georgee1199ec2014-05-10 17:48:01 +010094#endif
95
Damien George66e18f02014-05-05 13:19:03 +010096// Initial amount for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +010097#ifndef MICROPY_ALLOC_PARSE_RULE_INIT
98#define MICROPY_ALLOC_PARSE_RULE_INIT (64)
Damien George66e18f02014-05-05 13:19:03 +010099#endif
100
101// Increment for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100102#ifndef MICROPY_ALLOC_PARSE_RULE_INC
103#define MICROPY_ALLOC_PARSE_RULE_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100104#endif
105
106// Initial amount for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100107#ifndef MICROPY_ALLOC_PARSE_RESULT_INIT
108#define MICROPY_ALLOC_PARSE_RESULT_INIT (32)
Damien George66e18f02014-05-05 13:19:03 +0100109#endif
110
111// Increment for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100112#ifndef MICROPY_ALLOC_PARSE_RESULT_INC
113#define MICROPY_ALLOC_PARSE_RESULT_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100114#endif
115
Damien George5042bce2014-05-25 22:06:06 +0100116// Strings this length or less will be interned by the parser
117#ifndef MICROPY_ALLOC_PARSE_INTERN_STRING_LEN
118#define MICROPY_ALLOC_PARSE_INTERN_STRING_LEN (10)
119#endif
120
Damien George58e0f4a2015-09-23 10:50:43 +0100121// Number of bytes to allocate initially when creating new chunks to store
122// parse nodes. Small leads to fragmentation, large leads to excess use.
123#ifndef MICROPY_ALLOC_PARSE_CHUNK_INIT
124#define MICROPY_ALLOC_PARSE_CHUNK_INIT (128)
125#endif
126
Damien George66e18f02014-05-05 13:19:03 +0100127// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100128#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
129#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100130#endif
131
132// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100133#ifndef MICROPY_ALLOC_SCOPE_ID_INC
134#define MICROPY_ALLOC_SCOPE_ID_INC (6)
135#endif
136
137// Maximum length of a path in the filesystem
138// So we can allocate a buffer on the stack for path manipulation in import
139#ifndef MICROPY_ALLOC_PATH_MAX
140#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100141#endif
142
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200143// Initial size of module dict
144#ifndef MICROPY_MODULE_DICT_SIZE
145#define MICROPY_MODULE_DICT_SIZE (1)
146#endif
147
Damien Georged8914522015-02-27 09:54:12 +0000148// Whether realloc/free should be passed allocated memory region size
149// You must enable this if MICROPY_MEM_STATS is enabled
150#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
151#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
152#endif
153
Damien George95836f82015-01-11 22:27:30 +0000154// Number of bytes used to store qstr length
155// Dictates hard limit on maximum Python identifier length, but 1 byte
156// (limit of 255 bytes in an identifier) should be enough for everyone
157#ifndef MICROPY_QSTR_BYTES_IN_LEN
158#define MICROPY_QSTR_BYTES_IN_LEN (1)
159#endif
160
Damien Georgec3bd9412015-07-20 11:03:13 +0000161// Number of bytes used to store qstr hash
162#ifndef MICROPY_QSTR_BYTES_IN_HASH
163#define MICROPY_QSTR_BYTES_IN_HASH (2)
164#endif
165
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200166// Avoid using C stack when making Python function calls. C stack still
167// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200168#ifndef MICROPY_STACKLESS
169#define MICROPY_STACKLESS (0)
170#endif
171
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200172// Never use C stack when making Python function calls. This may break
173// testsuite as will subtly change which exception is thrown in case
174// of too deep recursion and other similar cases.
175#ifndef MICROPY_STACKLESS_STRICT
176#define MICROPY_STACKLESS_STRICT (0)
177#endif
178
Damien George66e18f02014-05-05 13:19:03 +0100179/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000180/* Micro Python emitters */
181
Damien George136f6752014-01-07 14:54:15 +0000182// Whether to emit x64 native code
183#ifndef MICROPY_EMIT_X64
184#define MICROPY_EMIT_X64 (0)
185#endif
186
Damien Georgec90f59e2014-09-06 23:06:36 +0100187// Whether to emit x86 native code
188#ifndef MICROPY_EMIT_X86
189#define MICROPY_EMIT_X86 (0)
190#endif
191
Damien George136f6752014-01-07 14:54:15 +0000192// Whether to emit thumb native code
193#ifndef MICROPY_EMIT_THUMB
194#define MICROPY_EMIT_THUMB (0)
195#endif
196
197// Whether to enable the thumb inline assembler
198#ifndef MICROPY_EMIT_INLINE_THUMB
199#define MICROPY_EMIT_INLINE_THUMB (0)
200#endif
201
=50089722015-04-14 13:14:57 +0100202// Whether to enable float support in the Thumb2 inline assembler
203#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
204#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
205#endif
206
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200207// Whether to emit ARM native code
208#ifndef MICROPY_EMIT_ARM
209#define MICROPY_EMIT_ARM (0)
210#endif
211
Damien George2ac4af62014-08-15 16:45:41 +0100212// Convenience definition for whether any native emitter is enabled
Damien Georgec90f59e2014-09-06 23:06:36 +0100213#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM)
Damien George2ac4af62014-08-15 16:45:41 +0100214
Damien George136f6752014-01-07 14:54:15 +0000215/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100216/* Compiler configuration */
217
Damien George64f2b212015-10-08 14:58:15 +0100218// Whether to enable constant folding; eg 1+2 rewritten as 3
219#ifndef MICROPY_COMP_CONST_FOLDING
220#define MICROPY_COMP_CONST_FOLDING (1)
221#endif
222
Damien Georgeddd1e182015-01-10 14:07:24 +0000223// Whether to enable lookup of constants in modules; eg module.CONST
224#ifndef MICROPY_COMP_MODULE_CONST
225#define MICROPY_COMP_MODULE_CONST (0)
226#endif
227
Damien George58ebde42014-05-21 20:32:59 +0100228// Whether to enable constant optimisation; id = const(value)
229#ifndef MICROPY_COMP_CONST
230#define MICROPY_COMP_CONST (1)
231#endif
232
Damien George42e0c592015-03-14 13:11:35 +0000233// Whether to enable optimisation of: a, b = c, d
234// Costs 124 bytes (Thumb2)
235#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
236#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
237#endif
238
239// Whether to enable optimisation of: a, b, c = d, e, f
240// Cost 156 bytes (Thumb2)
241#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
242#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
243#endif
244
Damien George58ebde42014-05-21 20:32:59 +0100245/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000246/* Internal debugging stuff */
247
248// Whether to collect memory allocation stats
249#ifndef MICROPY_MEM_STATS
250#define MICROPY_MEM_STATS (0)
251#endif
252
Damien Georgecbd2f742014-01-19 11:48:48 +0000253// Whether to build functions that print debugging info:
nhtshot5d323de2015-02-23 15:05:32 -0600254// mp_lexer_show_token
Damien George3417bc22014-05-10 10:36:38 +0100255// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000256// mp_parse_node_print
257#ifndef MICROPY_DEBUG_PRINTERS
258#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000259#endif
260
Damien George136f6752014-01-07 14:54:15 +0000261/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100262/* Optimisations */
263
264// Whether to use computed gotos in the VM, or a switch
265// Computed gotos are roughly 10% faster, and increase VM code size by a little
266#ifndef MICROPY_OPT_COMPUTED_GOTO
267#define MICROPY_OPT_COMPUTED_GOTO (0)
268#endif
269
Damien George7ee91cf2015-01-06 12:51:39 +0000270// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
271// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
272// uses a bit of extra code ROM, but greatly improves lookup speed.
273#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
274#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
275#endif
276
Damien Georgeee3fd462014-05-24 23:03:12 +0100277/*****************************************************************************/
278/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000279
Damien Georged3ebe482014-01-07 15:20:33 +0000280// Whether to include the garbage collector
281#ifndef MICROPY_ENABLE_GC
282#define MICROPY_ENABLE_GC (0)
283#endif
284
Damien George12bab722014-04-05 20:35:48 +0100285// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000286#ifndef MICROPY_ENABLE_FINALISER
287#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100288#endif
289
Paul Sokolovsky23668692014-06-25 03:03:34 +0300290// Whether to check C stack usage. C stack used for calling Python functions,
291// etc. Not checking means segfault on overflow.
292#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000293#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300294#endif
295
Dave Hylands5b7fd202014-07-01 23:46:53 -0700296// Whether to have an emergency exception buffer
297#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
298#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
299#endif
300#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
301# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
302# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
303# endif
304#endif
305
Damien George136f6752014-01-07 14:54:15 +0000306// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100307#ifndef MICROPY_HELPER_REPL
308#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000309#endif
310
Tom Soulanille7d588b02015-07-09 16:32:36 -0700311// Whether to include emacs-style readline behavior in REPL
312#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100313#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700314#endif
315
Damien George0af73012015-08-20 10:34:16 +0100316// Whether to implement auto-indent in REPL
317#ifndef MICROPY_REPL_AUTO_INDENT
318#define MICROPY_REPL_AUTO_INDENT (0)
319#endif
320
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200321// Whether port requires event-driven REPL functions
322#ifndef MICROPY_REPL_EVENT_DRIVEN
323#define MICROPY_REPL_EVENT_DRIVEN (0)
324#endif
325
Damien Georged3ebe482014-01-07 15:20:33 +0000326// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100327#ifndef MICROPY_HELPER_LEXER_UNIX
328#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000329#endif
330
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200331// Long int implementation
332#define MICROPY_LONGINT_IMPL_NONE (0)
333#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000334#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200335
336#ifndef MICROPY_LONGINT_IMPL
337#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
338#endif
339
340#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
341typedef long long mp_longint_impl_t;
342#endif
343
Damien George62ad1892014-01-29 21:51:51 +0000344// Whether to include information in the byte code to determine source
345// line number (increases RAM usage, but doesn't slow byte code execution)
346#ifndef MICROPY_ENABLE_SOURCE_LINE
347#define MICROPY_ENABLE_SOURCE_LINE (0)
348#endif
349
Damien George1463c1f2014-04-25 23:52:57 +0100350// Whether to include doc strings (increases RAM usage)
351#ifndef MICROPY_ENABLE_DOC_STRING
352#define MICROPY_ENABLE_DOC_STRING (0)
353#endif
354
Damien George1e9a92f2014-11-06 17:36:16 +0000355// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300356#define MICROPY_ERROR_REPORTING_TERSE (1)
357// Exception messages provide basic error details
358#define MICROPY_ERROR_REPORTING_NORMAL (2)
359// Exception messages provide full info, e.g. object names
360#define MICROPY_ERROR_REPORTING_DETAILED (3)
361
362#ifndef MICROPY_ERROR_REPORTING
363#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
364#endif
365
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200366// Whether issue warnings during compiling/execution
367#ifndef MICROPY_WARNINGS
368#define MICROPY_WARNINGS (0)
369#endif
370
Damien George0c36da02014-03-08 15:24:39 +0000371// Float and complex implementation
372#define MICROPY_FLOAT_IMPL_NONE (0)
373#define MICROPY_FLOAT_IMPL_FLOAT (1)
374#define MICROPY_FLOAT_IMPL_DOUBLE (2)
375
376#ifndef MICROPY_FLOAT_IMPL
377#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
378#endif
379
380#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100381#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000382#define MICROPY_FLOAT_C_FUN(fun) fun##f
383typedef float mp_float_t;
384#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100385#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000386#define MICROPY_FLOAT_C_FUN(fun) fun
387typedef double mp_float_t;
388#else
Damien Georgefb510b32014-06-01 13:32:54 +0100389#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000390#endif
391
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300392#ifndef MICROPY_PY_BUILTINS_COMPLEX
393#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
394#endif
395
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200396// Enable features which improve CPython compatibility
397// but may lead to more code size/memory usage.
398// TODO: Originally intended as generic category to not
399// add bunch of once-off options. May need refactoring later
400#ifndef MICROPY_CPYTHON_COMPAT
401#define MICROPY_CPYTHON_COMPAT (1)
402#endif
403
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300404// Whether POSIX-semantics non-blocking streams are supported
405#ifndef MICROPY_STREAMS_NON_BLOCK
406#define MICROPY_STREAMS_NON_BLOCK (0)
407#endif
408
Damien Georgec14a8162014-10-12 11:46:04 +0100409// Whether module weak links are supported
410#ifndef MICROPY_MODULE_WEAK_LINKS
411#define MICROPY_MODULE_WEAK_LINKS (0)
412#endif
413
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200414// Whether frozen modules are supported
415#ifndef MICROPY_MODULE_FROZEN
416#define MICROPY_MODULE_FROZEN (0)
417#endif
418
Damien George78d702c2014-12-09 16:19:48 +0000419// Whether you can override builtins in the builtins module
420#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
421#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
422#endif
423
Damien George06593fb2015-06-19 12:49:10 +0000424// Whether to check that the "self" argument of a builtin method has the
425// correct type. Such an explicit check is only needed if a builtin
426// method escapes to Python land without a first argument, eg
427// list.append([], 1). Without this check such calls will have undefined
428// behaviour (usually segfault) if the first argument is the wrong type.
429#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
430#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
431#endif
432
Damien Georgeee3fd462014-05-24 23:03:12 +0100433/*****************************************************************************/
434/* Fine control over Python builtins, classes, modules, etc */
435
stijn3cc17c62015-02-14 18:44:31 +0100436// Whether to implement attributes on functions
437#ifndef MICROPY_PY_FUNCTION_ATTRS
438#define MICROPY_PY_FUNCTION_ATTRS (0)
439#endif
440
stijn28fa84b2015-02-14 18:43:54 +0100441// Whether to support descriptors (__get__ and __set__)
442// This costs some code size and makes all load attrs and store attrs slow
443#ifndef MICROPY_PY_DESCRIPTORS
444#define MICROPY_PY_DESCRIPTORS (0)
445#endif
446
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300447// Whether str object is proper unicode
448#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
449#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100450#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100451
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300452// Whether str.splitlines() method provided
453#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
454#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
455#endif
456
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300457// Whether to support bytearray object
458#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
459#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300460#endif
461
Damien Georgedd4f4532014-10-23 13:34:35 +0100462// Whether to support memoryview object
463#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
464#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
465#endif
466
Damien George3ebd4d02014-06-01 13:46:47 +0100467// Whether to support set object
468#ifndef MICROPY_PY_BUILTINS_SET
469#define MICROPY_PY_BUILTINS_SET (1)
470#endif
471
Damien Georgefb510b32014-06-01 13:32:54 +0100472// Whether to support slice subscript operators and slice object
473#ifndef MICROPY_PY_BUILTINS_SLICE
474#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100475#endif
476
Tom Soulanilleaeb62f92015-09-11 14:31:32 -0700477// Whether to support slice attribute read access,
478// i.e. slice.start, slice.stop, slice.step
479#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
480#define MICROPY_PY_BUILTINS_SLICE_ATTRS (0)
481#endif
482
Damien Georgeee3fd462014-05-24 23:03:12 +0100483// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100484#ifndef MICROPY_PY_BUILTINS_FROZENSET
485#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100486#endif
487
Damien Georgefb510b32014-06-01 13:32:54 +0100488// Whether to support property object
489#ifndef MICROPY_PY_BUILTINS_PROPERTY
490#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100491#endif
492
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500493// Whether to implement the start/stop/step attributes (readback) on
494// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
495#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
496#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
497#endif
498
Daniel Campora077812b2015-06-29 22:45:39 +0200499// Whether to support timeout exceptions (like socket.timeout)
500#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
501#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
502#endif
503
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200504// Whether to support complete set of special methods
505// for user classes, otherwise only the most used
506#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
507#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
508#endif
509
Damien Georgec9fc6202014-10-25 21:59:14 +0100510// Whether to support compile function
511#ifndef MICROPY_PY_BUILTINS_COMPILE
512#define MICROPY_PY_BUILTINS_COMPILE (0)
513#endif
514
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300515// Whether to support enumerate function(type)
516#ifndef MICROPY_PY_BUILTINS_ENUMERATE
517#define MICROPY_PY_BUILTINS_ENUMERATE (1)
518#endif
519
Damien George2a3e2b92014-12-19 13:36:17 +0000520// Whether to support the Python 2 execfile function
521#ifndef MICROPY_PY_BUILTINS_EXECFILE
522#define MICROPY_PY_BUILTINS_EXECFILE (0)
523#endif
524
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300525// Whether to support filter function(type)
526#ifndef MICROPY_PY_BUILTINS_FILTER
527#define MICROPY_PY_BUILTINS_FILTER (1)
528#endif
529
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300530// Whether to support reversed function(type)
531#ifndef MICROPY_PY_BUILTINS_REVERSED
532#define MICROPY_PY_BUILTINS_REVERSED (1)
533#endif
534
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300535// Whether to define "NotImplemented" special constant
536#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
537#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
538#endif
539
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300540// Whether to set __file__ for imported modules
541#ifndef MICROPY_PY___FILE__
542#define MICROPY_PY___FILE__ (1)
543#endif
544
Damien George89deec02015-01-09 20:12:54 +0000545// Whether to provide mem-info related functions in micropython module
546#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
547#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
548#endif
549
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300550// Whether to provide "array" module. Note that large chunk of the
551// underlying code is shared with "bytearray" builtin type, so to
552// get real savings, it should be disabled too.
553#ifndef MICROPY_PY_ARRAY
554#define MICROPY_PY_ARRAY (1)
555#endif
556
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200557// Whether to support slice assignments for array (and bytearray).
558// This is rarely used, but adds ~0.5K of code.
559#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
560#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
561#endif
562
Damien George5aa311d2015-04-21 14:14:24 +0000563// Whether to support attrtuple type (MicroPython extension)
564// It provides space-efficient tuples with attribute access
565#ifndef MICROPY_PY_ATTRTUPLE
566#define MICROPY_PY_ATTRTUPLE (1)
567#endif
568
Damien Georgeee3fd462014-05-24 23:03:12 +0100569// Whether to provide "collections" module
570#ifndef MICROPY_PY_COLLECTIONS
571#define MICROPY_PY_COLLECTIONS (1)
572#endif
573
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200574// Whether to provide "collections.OrderedDict" type
575#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
576#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
577#endif
578
Damien Georgeee3fd462014-05-24 23:03:12 +0100579// Whether to provide "math" module
580#ifndef MICROPY_PY_MATH
581#define MICROPY_PY_MATH (1)
582#endif
583
Damien George5cbeace2015-02-22 14:48:18 +0000584// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
585#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
586#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
587#endif
588
Damien Georgeee3fd462014-05-24 23:03:12 +0100589// Whether to provide "cmath" module
590#ifndef MICROPY_PY_CMATH
591#define MICROPY_PY_CMATH (0)
592#endif
593
594// Whether to provide "gc" module
595#ifndef MICROPY_PY_GC
596#define MICROPY_PY_GC (1)
597#endif
598
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300599// Whether to return number of collected objects from gc.collect()
600#ifndef MICROPY_PY_GC_COLLECT_RETVAL
601#define MICROPY_PY_GC_COLLECT_RETVAL (0)
602#endif
603
Damien Georgeee3fd462014-05-24 23:03:12 +0100604// Whether to provide "io" module
605#ifndef MICROPY_PY_IO
606#define MICROPY_PY_IO (1)
607#endif
608
609// Whether to provide "io.FileIO" class
610#ifndef MICROPY_PY_IO_FILEIO
611#define MICROPY_PY_IO_FILEIO (0)
612#endif
613
614// Whether to provide "io.BytesIO" class
615#ifndef MICROPY_PY_IO_BYTESIO
616#define MICROPY_PY_IO_BYTESIO (1)
617#endif
618
619// Whether to provide "struct" module
620#ifndef MICROPY_PY_STRUCT
621#define MICROPY_PY_STRUCT (1)
622#endif
623
624// Whether to provide "sys" module
625#ifndef MICROPY_PY_SYS
626#define MICROPY_PY_SYS (1)
627#endif
628
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300629// Whether to provide "sys.maxsize" constant
630#ifndef MICROPY_PY_SYS_MAXSIZE
631#define MICROPY_PY_SYS_MAXSIZE (0)
632#endif
633
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300634// Whether to provide "sys.exc_info" function
635// Avoid enabling this, this function is Python2 heritage
636#ifndef MICROPY_PY_SYS_EXC_INFO
637#define MICROPY_PY_SYS_EXC_INFO (0)
638#endif
639
Damien Georgeee3fd462014-05-24 23:03:12 +0100640// Whether to provide "sys.exit" function
641#ifndef MICROPY_PY_SYS_EXIT
642#define MICROPY_PY_SYS_EXIT (0)
643#endif
644
645// Whether to provide sys.{stdin,stdout,stderr} objects
646#ifndef MICROPY_PY_SYS_STDFILES
647#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100648#endif
649
Damien George3c4b5d42015-05-13 23:49:21 +0100650// Whether to provide sys.{stdin,stdout,stderr}.buffer object
651// This is implemented per-port
652#ifndef MICROPY_PY_SYS_STDIO_BUFFER
653#define MICROPY_PY_SYS_STDIO_BUFFER (0)
654#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300655
656// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +0300657
Paul Sokolovsky82158472014-06-28 03:03:47 +0300658#ifndef MICROPY_PY_UCTYPES
659#define MICROPY_PY_UCTYPES (0)
660#endif
661
Paul Sokolovsky34162872014-10-12 08:16:34 -0700662#ifndef MICROPY_PY_UZLIB
663#define MICROPY_PY_UZLIB (0)
664#endif
665
Damien George612045f2014-09-17 22:56:34 +0100666#ifndef MICROPY_PY_UJSON
667#define MICROPY_PY_UJSON (0)
668#endif
669
Paul Sokolovskyc71e0452014-09-12 18:48:07 +0300670#ifndef MICROPY_PY_URE
671#define MICROPY_PY_URE (0)
672#endif
673
Damien Georgef5d69792014-10-22 17:37:18 +0000674#ifndef MICROPY_PY_UHEAPQ
675#define MICROPY_PY_UHEAPQ (0)
676#endif
677
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +0200678#ifndef MICROPY_PY_UHASHLIB
679#define MICROPY_PY_UHASHLIB (0)
680#endif
681
Paul Sokolovskybfdc2052014-11-29 06:19:30 +0200682#ifndef MICROPY_PY_UBINASCII
683#define MICROPY_PY_UBINASCII (0)
684#endif
685
Paul Sokolovsky01162182015-05-03 20:25:40 +0300686#ifndef MICROPY_PY_MACHINE
687#define MICROPY_PY_MACHINE (0)
688#endif
689
Paul Sokolovskyaaa88672015-10-06 18:10:00 +0300690#ifndef MICROPY_PY_USSL
691#define MICROPY_PY_USSL (0)
692#endif
693
Damien George58ebde42014-05-21 20:32:59 +0100694/*****************************************************************************/
695/* Hooks for a port to add builtins */
696
Damien Georgecaac5422014-03-25 14:18:18 +0000697// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100698#ifndef MICROPY_PORT_BUILTINS
699#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +0200700#endif
Damien Georgecaac5422014-03-25 14:18:18 +0000701
702// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100703#ifndef MICROPY_PORT_BUILTIN_MODULES
704#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +0000705#endif
706
Damien Georgec14a8162014-10-12 11:46:04 +0100707// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
708#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
709#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
710#endif
711
Damien George57e99eb2014-04-10 22:42:11 +0100712// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +0100713#ifndef MICROPY_PORT_CONSTANTS
714#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +0100715#endif
716
Damien Georgeb4b10fd2015-01-01 23:30:53 +0000717// Any root pointers for GC scanning - see mpstate.c
718#ifndef MICROPY_PORT_ROOT_POINTERS
719#define MICROPY_PORT_ROOT_POINTERS
720#endif
721
Damien George136f6752014-01-07 14:54:15 +0000722/*****************************************************************************/
723/* Miscellaneous settings */
724
Damien George28631532015-02-08 13:42:00 +0000725// All uPy objects in ROM must be aligned on at least a 4 byte boundary
726// so that the small-int/qstr/pointer distinction can be made. For machines
727// that don't do this (eg 16-bit CPU), define the following macro to something
728// like __attribute__((aligned(4))).
729#ifndef MICROPY_OBJ_BASE_ALIGNMENT
730#define MICROPY_OBJ_BASE_ALIGNMENT
731#endif
732
Dave Hylands5b7fd202014-07-01 23:46:53 -0700733// On embedded platforms, these will typically enable/disable irqs.
734#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000735#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700736#endif
737#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000738#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700739#endif
740
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200741// Allow to override static modifier for global objects, e.g. to use with
742// object code analysis tools which don't support static symbols.
743#ifndef STATIC
744#define STATIC static
745#endif
746
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200747#define BITS_PER_BYTE (8)
748#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +0100749// mp_int_t value with most significant bit set
750#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200751
Damien Georgea9bcd512014-10-06 13:44:59 +0000752// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
753// defined and that they are the opposite of each other.
754#if defined(MP_ENDIANNESS_LITTLE)
755#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
756#elif defined(MP_ENDIANNESS_BIG)
757#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
758#else
759 // Endiannes not defined by port so try to autodetect it.
760 #if defined(__BYTE_ORDER__)
761 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
762 #define MP_ENDIANNESS_LITTLE (1)
763 #else
764 #define MP_ENDIANNESS_LITTLE (0)
765 #endif
Damien Georgef32498f2014-10-06 16:09:31 +0000766 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
767 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +0000768 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
769 #define MP_ENDIANNESS_LITTLE (0)
770 #else
Damien George4e4772b2015-05-30 23:12:30 +0100771 #include <endian.h>
772 #if defined(__BYTE_ORDER)
773 #if __BYTE_ORDER == __LITTLE_ENDIAN
774 #define MP_ENDIANNESS_LITTLE (1)
775 #else
776 #define MP_ENDIANNESS_LITTLE (0)
777 #endif
778 #else
779 #error endianness not defined and cannot detect it
780 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +0000781 #endif
782 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +0100783#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +0300784
Damien George3c658a42014-08-24 16:28:17 +0100785// Make a pointer to RAM callable (eg set lower bit for Thumb code)
786// (This scheme won't work if we want to mix Thumb and normal ARM code.)
787#ifndef MICROPY_MAKE_POINTER_CALLABLE
788#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
789#endif
790
Damien George7f9d1d62015-04-09 23:56:15 +0100791// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +0000792// must be somehow reachable for marking by the GC, since the native code
793// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +0200794#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +0000795#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 +0200796#endif
797
798#ifndef MP_PLAT_FREE_EXEC
799#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
800#endif
801
Damien George7f9d1d62015-04-09 23:56:15 +0100802// This macro is used to do all output (except when MICROPY_PY_IO is defined)
803#ifndef MP_PLAT_PRINT_STRN
804#define MP_PLAT_PRINT_STRN(str, len) printf("%.*s", (int)len, str)
805#endif
806
Paul Sokolovsky722e5622014-09-06 19:17:23 +0300807#ifndef MP_SSIZE_MAX
808#define MP_SSIZE_MAX SSIZE_MAX
809#endif
810
Damien George40f3c022014-07-03 13:25:24 +0100811// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +0000812#ifndef INT_FMT
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200813#ifdef __LP64__
Damien George40f3c022014-07-03 13:25:24 +0100814// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200815#define UINT_FMT "%lu"
816#define INT_FMT "%ld"
817#else
Damien George40f3c022014-07-03 13:25:24 +0100818// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200819#define UINT_FMT "%u"
820#define INT_FMT "%d"
821#endif
822#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +0300823
824// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +0200825#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +0300826#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +0200827#endif
mux5c8db482014-06-21 17:24:55 +0200828
829// Modifier for weak functions
830#ifndef MP_WEAK
831#define MP_WEAK __attribute__((weak))
832#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +0200833
834// Condition is likely to be true, to help branch prediction
835#ifndef MP_LIKELY
836#define MP_LIKELY(x) __builtin_expect((x), 1)
837#endif
838
839// Condition is likely to be false, to help branch prediction
840#ifndef MP_UNLIKELY
841#define MP_UNLIKELY(x) __builtin_expect((x), 0)
842#endif
Damien George9ddbe292014-12-29 01:02:19 +0000843
844#endif // __MICROPY_INCLUDED_PY_MPCONFIG_H__