blob: ce6fa6ceaee74c869e0a24102b103630ab6bb7bc [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 George66e18f02014-05-05 13:19:03 +0100121// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100122#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
123#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100124#endif
125
126// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100127#ifndef MICROPY_ALLOC_SCOPE_ID_INC
128#define MICROPY_ALLOC_SCOPE_ID_INC (6)
129#endif
130
131// Maximum length of a path in the filesystem
132// So we can allocate a buffer on the stack for path manipulation in import
133#ifndef MICROPY_ALLOC_PATH_MAX
134#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100135#endif
136
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200137// Initial size of module dict
138#ifndef MICROPY_MODULE_DICT_SIZE
139#define MICROPY_MODULE_DICT_SIZE (1)
140#endif
141
Damien Georged8914522015-02-27 09:54:12 +0000142// Whether realloc/free should be passed allocated memory region size
143// You must enable this if MICROPY_MEM_STATS is enabled
144#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
145#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
146#endif
147
Damien George95836f82015-01-11 22:27:30 +0000148// Number of bytes used to store qstr length
149// Dictates hard limit on maximum Python identifier length, but 1 byte
150// (limit of 255 bytes in an identifier) should be enough for everyone
151#ifndef MICROPY_QSTR_BYTES_IN_LEN
152#define MICROPY_QSTR_BYTES_IN_LEN (1)
153#endif
154
Damien Georgec3bd9412015-07-20 11:03:13 +0000155// Number of bytes used to store qstr hash
156#ifndef MICROPY_QSTR_BYTES_IN_HASH
157#define MICROPY_QSTR_BYTES_IN_HASH (2)
158#endif
159
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200160// Avoid using C stack when making Python function calls. C stack still
161// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200162#ifndef MICROPY_STACKLESS
163#define MICROPY_STACKLESS (0)
164#endif
165
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200166// Never use C stack when making Python function calls. This may break
167// testsuite as will subtly change which exception is thrown in case
168// of too deep recursion and other similar cases.
169#ifndef MICROPY_STACKLESS_STRICT
170#define MICROPY_STACKLESS_STRICT (0)
171#endif
172
Damien George66e18f02014-05-05 13:19:03 +0100173/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000174/* Micro Python emitters */
175
Damien George136f6752014-01-07 14:54:15 +0000176// Whether to emit x64 native code
177#ifndef MICROPY_EMIT_X64
178#define MICROPY_EMIT_X64 (0)
179#endif
180
Damien Georgec90f59e2014-09-06 23:06:36 +0100181// Whether to emit x86 native code
182#ifndef MICROPY_EMIT_X86
183#define MICROPY_EMIT_X86 (0)
184#endif
185
Damien George136f6752014-01-07 14:54:15 +0000186// Whether to emit thumb native code
187#ifndef MICROPY_EMIT_THUMB
188#define MICROPY_EMIT_THUMB (0)
189#endif
190
191// Whether to enable the thumb inline assembler
192#ifndef MICROPY_EMIT_INLINE_THUMB
193#define MICROPY_EMIT_INLINE_THUMB (0)
194#endif
195
=50089722015-04-14 13:14:57 +0100196// Whether to enable float support in the Thumb2 inline assembler
197#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
198#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
199#endif
200
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200201// Whether to emit ARM native code
202#ifndef MICROPY_EMIT_ARM
203#define MICROPY_EMIT_ARM (0)
204#endif
205
Damien George2ac4af62014-08-15 16:45:41 +0100206// Convenience definition for whether any native emitter is enabled
Damien Georgec90f59e2014-09-06 23:06:36 +0100207#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM)
Damien George2ac4af62014-08-15 16:45:41 +0100208
Damien George136f6752014-01-07 14:54:15 +0000209/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100210/* Compiler configuration */
211
Damien Georgeddd1e182015-01-10 14:07:24 +0000212// Whether to enable lookup of constants in modules; eg module.CONST
213#ifndef MICROPY_COMP_MODULE_CONST
214#define MICROPY_COMP_MODULE_CONST (0)
215#endif
216
Damien George58ebde42014-05-21 20:32:59 +0100217// Whether to enable constant optimisation; id = const(value)
218#ifndef MICROPY_COMP_CONST
219#define MICROPY_COMP_CONST (1)
220#endif
221
Damien George42e0c592015-03-14 13:11:35 +0000222// Whether to enable optimisation of: a, b = c, d
223// Costs 124 bytes (Thumb2)
224#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
225#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
226#endif
227
228// Whether to enable optimisation of: a, b, c = d, e, f
229// Cost 156 bytes (Thumb2)
230#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
231#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
232#endif
233
Damien George58ebde42014-05-21 20:32:59 +0100234/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000235/* Internal debugging stuff */
236
237// Whether to collect memory allocation stats
238#ifndef MICROPY_MEM_STATS
239#define MICROPY_MEM_STATS (0)
240#endif
241
Damien Georgecbd2f742014-01-19 11:48:48 +0000242// Whether to build functions that print debugging info:
nhtshot5d323de2015-02-23 15:05:32 -0600243// mp_lexer_show_token
Damien George3417bc22014-05-10 10:36:38 +0100244// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000245// mp_parse_node_print
246#ifndef MICROPY_DEBUG_PRINTERS
247#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000248#endif
249
Damien George136f6752014-01-07 14:54:15 +0000250/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100251/* Optimisations */
252
253// Whether to use computed gotos in the VM, or a switch
254// Computed gotos are roughly 10% faster, and increase VM code size by a little
255#ifndef MICROPY_OPT_COMPUTED_GOTO
256#define MICROPY_OPT_COMPUTED_GOTO (0)
257#endif
258
Damien George7ee91cf2015-01-06 12:51:39 +0000259// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
260// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
261// uses a bit of extra code ROM, but greatly improves lookup speed.
262#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
263#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
264#endif
265
Damien Georgeee3fd462014-05-24 23:03:12 +0100266/*****************************************************************************/
267/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000268
Damien Georged3ebe482014-01-07 15:20:33 +0000269// Whether to include the garbage collector
270#ifndef MICROPY_ENABLE_GC
271#define MICROPY_ENABLE_GC (0)
272#endif
273
Damien George12bab722014-04-05 20:35:48 +0100274// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000275#ifndef MICROPY_ENABLE_FINALISER
276#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100277#endif
278
Paul Sokolovsky23668692014-06-25 03:03:34 +0300279// Whether to check C stack usage. C stack used for calling Python functions,
280// etc. Not checking means segfault on overflow.
281#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000282#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300283#endif
284
Dave Hylands5b7fd202014-07-01 23:46:53 -0700285// Whether to have an emergency exception buffer
286#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
287#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
288#endif
289#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
290# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
291# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
292# endif
293#endif
294
Damien George136f6752014-01-07 14:54:15 +0000295// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100296#ifndef MICROPY_HELPER_REPL
297#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000298#endif
299
Tom Soulanille7d588b02015-07-09 16:32:36 -0700300// Whether to include emacs-style readline behavior in REPL
301#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100302#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700303#endif
304
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200305// Whether port requires event-driven REPL functions
306#ifndef MICROPY_REPL_EVENT_DRIVEN
307#define MICROPY_REPL_EVENT_DRIVEN (0)
308#endif
309
Damien Georged3ebe482014-01-07 15:20:33 +0000310// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100311#ifndef MICROPY_HELPER_LEXER_UNIX
312#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000313#endif
314
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200315// Long int implementation
316#define MICROPY_LONGINT_IMPL_NONE (0)
317#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000318#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200319
320#ifndef MICROPY_LONGINT_IMPL
321#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
322#endif
323
324#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
325typedef long long mp_longint_impl_t;
326#endif
327
Damien George62ad1892014-01-29 21:51:51 +0000328// Whether to include information in the byte code to determine source
329// line number (increases RAM usage, but doesn't slow byte code execution)
330#ifndef MICROPY_ENABLE_SOURCE_LINE
331#define MICROPY_ENABLE_SOURCE_LINE (0)
332#endif
333
Damien George1463c1f2014-04-25 23:52:57 +0100334// Whether to include doc strings (increases RAM usage)
335#ifndef MICROPY_ENABLE_DOC_STRING
336#define MICROPY_ENABLE_DOC_STRING (0)
337#endif
338
Damien George1e9a92f2014-11-06 17:36:16 +0000339// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300340#define MICROPY_ERROR_REPORTING_TERSE (1)
341// Exception messages provide basic error details
342#define MICROPY_ERROR_REPORTING_NORMAL (2)
343// Exception messages provide full info, e.g. object names
344#define MICROPY_ERROR_REPORTING_DETAILED (3)
345
346#ifndef MICROPY_ERROR_REPORTING
347#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
348#endif
349
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200350// Whether issue warnings during compiling/execution
351#ifndef MICROPY_WARNINGS
352#define MICROPY_WARNINGS (0)
353#endif
354
Damien George0c36da02014-03-08 15:24:39 +0000355// Float and complex implementation
356#define MICROPY_FLOAT_IMPL_NONE (0)
357#define MICROPY_FLOAT_IMPL_FLOAT (1)
358#define MICROPY_FLOAT_IMPL_DOUBLE (2)
359
360#ifndef MICROPY_FLOAT_IMPL
361#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
362#endif
363
364#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100365#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000366#define MICROPY_FLOAT_C_FUN(fun) fun##f
367typedef float mp_float_t;
368#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100369#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000370#define MICROPY_FLOAT_C_FUN(fun) fun
371typedef double mp_float_t;
372#else
Damien Georgefb510b32014-06-01 13:32:54 +0100373#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000374#endif
375
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300376#ifndef MICROPY_PY_BUILTINS_COMPLEX
377#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
378#endif
379
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200380// Enable features which improve CPython compatibility
381// but may lead to more code size/memory usage.
382// TODO: Originally intended as generic category to not
383// add bunch of once-off options. May need refactoring later
384#ifndef MICROPY_CPYTHON_COMPAT
385#define MICROPY_CPYTHON_COMPAT (1)
386#endif
387
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300388// Whether POSIX-semantics non-blocking streams are supported
389#ifndef MICROPY_STREAMS_NON_BLOCK
390#define MICROPY_STREAMS_NON_BLOCK (0)
391#endif
392
Damien Georgec14a8162014-10-12 11:46:04 +0100393// Whether module weak links are supported
394#ifndef MICROPY_MODULE_WEAK_LINKS
395#define MICROPY_MODULE_WEAK_LINKS (0)
396#endif
397
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200398// Whether frozen modules are supported
399#ifndef MICROPY_MODULE_FROZEN
400#define MICROPY_MODULE_FROZEN (0)
401#endif
402
Damien George78d702c2014-12-09 16:19:48 +0000403// Whether you can override builtins in the builtins module
404#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
405#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
406#endif
407
Damien George06593fb2015-06-19 12:49:10 +0000408// Whether to check that the "self" argument of a builtin method has the
409// correct type. Such an explicit check is only needed if a builtin
410// method escapes to Python land without a first argument, eg
411// list.append([], 1). Without this check such calls will have undefined
412// behaviour (usually segfault) if the first argument is the wrong type.
413#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
414#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
415#endif
416
Damien Georgeee3fd462014-05-24 23:03:12 +0100417/*****************************************************************************/
418/* Fine control over Python builtins, classes, modules, etc */
419
stijn3cc17c62015-02-14 18:44:31 +0100420// Whether to implement attributes on functions
421#ifndef MICROPY_PY_FUNCTION_ATTRS
422#define MICROPY_PY_FUNCTION_ATTRS (0)
423#endif
424
stijn28fa84b2015-02-14 18:43:54 +0100425// Whether to support descriptors (__get__ and __set__)
426// This costs some code size and makes all load attrs and store attrs slow
427#ifndef MICROPY_PY_DESCRIPTORS
428#define MICROPY_PY_DESCRIPTORS (0)
429#endif
430
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300431// Whether str object is proper unicode
432#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
433#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100434#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100435
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300436// Whether str.splitlines() method provided
437#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
438#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
439#endif
440
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300441// Whether to support bytearray object
442#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
443#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300444#endif
445
Damien Georgedd4f4532014-10-23 13:34:35 +0100446// Whether to support memoryview object
447#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
448#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
449#endif
450
Damien George3ebd4d02014-06-01 13:46:47 +0100451// Whether to support set object
452#ifndef MICROPY_PY_BUILTINS_SET
453#define MICROPY_PY_BUILTINS_SET (1)
454#endif
455
Damien Georgefb510b32014-06-01 13:32:54 +0100456// Whether to support slice subscript operators and slice object
457#ifndef MICROPY_PY_BUILTINS_SLICE
458#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100459#endif
460
461// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100462#ifndef MICROPY_PY_BUILTINS_FROZENSET
463#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100464#endif
465
Damien Georgefb510b32014-06-01 13:32:54 +0100466// Whether to support property object
467#ifndef MICROPY_PY_BUILTINS_PROPERTY
468#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100469#endif
470
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500471// Whether to implement the start/stop/step attributes (readback) on
472// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
473#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
474#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
475#endif
476
Daniel Campora077812b2015-06-29 22:45:39 +0200477// Whether to support timeout exceptions (like socket.timeout)
478#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
479#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
480#endif
481
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200482// Whether to support complete set of special methods
483// for user classes, otherwise only the most used
484#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
485#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
486#endif
487
Damien Georgec9fc6202014-10-25 21:59:14 +0100488// Whether to support compile function
489#ifndef MICROPY_PY_BUILTINS_COMPILE
490#define MICROPY_PY_BUILTINS_COMPILE (0)
491#endif
492
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300493// Whether to support enumerate function(type)
494#ifndef MICROPY_PY_BUILTINS_ENUMERATE
495#define MICROPY_PY_BUILTINS_ENUMERATE (1)
496#endif
497
Damien George2a3e2b92014-12-19 13:36:17 +0000498// Whether to support the Python 2 execfile function
499#ifndef MICROPY_PY_BUILTINS_EXECFILE
500#define MICROPY_PY_BUILTINS_EXECFILE (0)
501#endif
502
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300503// Whether to support filter function(type)
504#ifndef MICROPY_PY_BUILTINS_FILTER
505#define MICROPY_PY_BUILTINS_FILTER (1)
506#endif
507
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300508// Whether to support reversed function(type)
509#ifndef MICROPY_PY_BUILTINS_REVERSED
510#define MICROPY_PY_BUILTINS_REVERSED (1)
511#endif
512
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300513// Whether to define "NotImplemented" special constant
514#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
515#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
516#endif
517
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300518// Whether to set __file__ for imported modules
519#ifndef MICROPY_PY___FILE__
520#define MICROPY_PY___FILE__ (1)
521#endif
522
Damien George89deec02015-01-09 20:12:54 +0000523// Whether to provide mem-info related functions in micropython module
524#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
525#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
526#endif
527
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300528// Whether to provide "array" module. Note that large chunk of the
529// underlying code is shared with "bytearray" builtin type, so to
530// get real savings, it should be disabled too.
531#ifndef MICROPY_PY_ARRAY
532#define MICROPY_PY_ARRAY (1)
533#endif
534
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200535// Whether to support slice assignments for array (and bytearray).
536// This is rarely used, but adds ~0.5K of code.
537#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
538#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
539#endif
540
Damien George5aa311d2015-04-21 14:14:24 +0000541// Whether to support attrtuple type (MicroPython extension)
542// It provides space-efficient tuples with attribute access
543#ifndef MICROPY_PY_ATTRTUPLE
544#define MICROPY_PY_ATTRTUPLE (1)
545#endif
546
Damien Georgeee3fd462014-05-24 23:03:12 +0100547// Whether to provide "collections" module
548#ifndef MICROPY_PY_COLLECTIONS
549#define MICROPY_PY_COLLECTIONS (1)
550#endif
551
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200552// Whether to provide "collections.OrderedDict" type
553#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
554#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
555#endif
556
Damien Georgeee3fd462014-05-24 23:03:12 +0100557// Whether to provide "math" module
558#ifndef MICROPY_PY_MATH
559#define MICROPY_PY_MATH (1)
560#endif
561
Damien George5cbeace2015-02-22 14:48:18 +0000562// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
563#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
564#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
565#endif
566
Damien Georgeee3fd462014-05-24 23:03:12 +0100567// Whether to provide "cmath" module
568#ifndef MICROPY_PY_CMATH
569#define MICROPY_PY_CMATH (0)
570#endif
571
572// Whether to provide "gc" module
573#ifndef MICROPY_PY_GC
574#define MICROPY_PY_GC (1)
575#endif
576
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300577// Whether to return number of collected objects from gc.collect()
578#ifndef MICROPY_PY_GC_COLLECT_RETVAL
579#define MICROPY_PY_GC_COLLECT_RETVAL (0)
580#endif
581
Damien Georgeee3fd462014-05-24 23:03:12 +0100582// Whether to provide "io" module
583#ifndef MICROPY_PY_IO
584#define MICROPY_PY_IO (1)
585#endif
586
587// Whether to provide "io.FileIO" class
588#ifndef MICROPY_PY_IO_FILEIO
589#define MICROPY_PY_IO_FILEIO (0)
590#endif
591
592// Whether to provide "io.BytesIO" class
593#ifndef MICROPY_PY_IO_BYTESIO
594#define MICROPY_PY_IO_BYTESIO (1)
595#endif
596
597// Whether to provide "struct" module
598#ifndef MICROPY_PY_STRUCT
599#define MICROPY_PY_STRUCT (1)
600#endif
601
602// Whether to provide "sys" module
603#ifndef MICROPY_PY_SYS
604#define MICROPY_PY_SYS (1)
605#endif
606
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300607// Whether to provide "sys.maxsize" constant
608#ifndef MICROPY_PY_SYS_MAXSIZE
609#define MICROPY_PY_SYS_MAXSIZE (0)
610#endif
611
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300612// Whether to provide "sys.exc_info" function
613// Avoid enabling this, this function is Python2 heritage
614#ifndef MICROPY_PY_SYS_EXC_INFO
615#define MICROPY_PY_SYS_EXC_INFO (0)
616#endif
617
Damien Georgeee3fd462014-05-24 23:03:12 +0100618// Whether to provide "sys.exit" function
619#ifndef MICROPY_PY_SYS_EXIT
620#define MICROPY_PY_SYS_EXIT (0)
621#endif
622
623// Whether to provide sys.{stdin,stdout,stderr} objects
624#ifndef MICROPY_PY_SYS_STDFILES
625#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100626#endif
627
Damien George3c4b5d42015-05-13 23:49:21 +0100628// Whether to provide sys.{stdin,stdout,stderr}.buffer object
629// This is implemented per-port
630#ifndef MICROPY_PY_SYS_STDIO_BUFFER
631#define MICROPY_PY_SYS_STDIO_BUFFER (0)
632#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300633
634// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +0300635
Paul Sokolovsky82158472014-06-28 03:03:47 +0300636#ifndef MICROPY_PY_UCTYPES
637#define MICROPY_PY_UCTYPES (0)
638#endif
639
Paul Sokolovsky34162872014-10-12 08:16:34 -0700640#ifndef MICROPY_PY_UZLIB
641#define MICROPY_PY_UZLIB (0)
642#endif
643
Damien George612045f2014-09-17 22:56:34 +0100644#ifndef MICROPY_PY_UJSON
645#define MICROPY_PY_UJSON (0)
646#endif
647
Paul Sokolovskyc71e0452014-09-12 18:48:07 +0300648#ifndef MICROPY_PY_URE
649#define MICROPY_PY_URE (0)
650#endif
651
Damien Georgef5d69792014-10-22 17:37:18 +0000652#ifndef MICROPY_PY_UHEAPQ
653#define MICROPY_PY_UHEAPQ (0)
654#endif
655
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +0200656#ifndef MICROPY_PY_UHASHLIB
657#define MICROPY_PY_UHASHLIB (0)
658#endif
659
Paul Sokolovskybfdc2052014-11-29 06:19:30 +0200660#ifndef MICROPY_PY_UBINASCII
661#define MICROPY_PY_UBINASCII (0)
662#endif
663
Paul Sokolovsky01162182015-05-03 20:25:40 +0300664#ifndef MICROPY_PY_MACHINE
665#define MICROPY_PY_MACHINE (0)
666#endif
667
Damien George58ebde42014-05-21 20:32:59 +0100668/*****************************************************************************/
669/* Hooks for a port to add builtins */
670
Damien Georgecaac5422014-03-25 14:18:18 +0000671// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100672#ifndef MICROPY_PORT_BUILTINS
673#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +0200674#endif
Damien Georgecaac5422014-03-25 14:18:18 +0000675
676// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100677#ifndef MICROPY_PORT_BUILTIN_MODULES
678#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +0000679#endif
680
Damien Georgec14a8162014-10-12 11:46:04 +0100681// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
682#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
683#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
684#endif
685
Damien George57e99eb2014-04-10 22:42:11 +0100686// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +0100687#ifndef MICROPY_PORT_CONSTANTS
688#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +0100689#endif
690
Damien Georgeb4b10fd2015-01-01 23:30:53 +0000691// Any root pointers for GC scanning - see mpstate.c
692#ifndef MICROPY_PORT_ROOT_POINTERS
693#define MICROPY_PORT_ROOT_POINTERS
694#endif
695
Damien George136f6752014-01-07 14:54:15 +0000696/*****************************************************************************/
697/* Miscellaneous settings */
698
Damien George28631532015-02-08 13:42:00 +0000699// All uPy objects in ROM must be aligned on at least a 4 byte boundary
700// so that the small-int/qstr/pointer distinction can be made. For machines
701// that don't do this (eg 16-bit CPU), define the following macro to something
702// like __attribute__((aligned(4))).
703#ifndef MICROPY_OBJ_BASE_ALIGNMENT
704#define MICROPY_OBJ_BASE_ALIGNMENT
705#endif
706
Dave Hylands5b7fd202014-07-01 23:46:53 -0700707// On embedded platforms, these will typically enable/disable irqs.
708#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000709#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700710#endif
711#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000712#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700713#endif
714
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200715// Allow to override static modifier for global objects, e.g. to use with
716// object code analysis tools which don't support static symbols.
717#ifndef STATIC
718#define STATIC static
719#endif
720
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200721#define BITS_PER_BYTE (8)
722#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +0100723// mp_int_t value with most significant bit set
724#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200725
Damien Georgea9bcd512014-10-06 13:44:59 +0000726// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
727// defined and that they are the opposite of each other.
728#if defined(MP_ENDIANNESS_LITTLE)
729#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
730#elif defined(MP_ENDIANNESS_BIG)
731#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
732#else
733 // Endiannes not defined by port so try to autodetect it.
734 #if defined(__BYTE_ORDER__)
735 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
736 #define MP_ENDIANNESS_LITTLE (1)
737 #else
738 #define MP_ENDIANNESS_LITTLE (0)
739 #endif
Damien Georgef32498f2014-10-06 16:09:31 +0000740 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
741 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +0000742 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
743 #define MP_ENDIANNESS_LITTLE (0)
744 #else
Damien George4e4772b2015-05-30 23:12:30 +0100745 #include <endian.h>
746 #if defined(__BYTE_ORDER)
747 #if __BYTE_ORDER == __LITTLE_ENDIAN
748 #define MP_ENDIANNESS_LITTLE (1)
749 #else
750 #define MP_ENDIANNESS_LITTLE (0)
751 #endif
752 #else
753 #error endianness not defined and cannot detect it
754 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +0000755 #endif
756 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +0100757#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +0300758
Damien George3c658a42014-08-24 16:28:17 +0100759// Make a pointer to RAM callable (eg set lower bit for Thumb code)
760// (This scheme won't work if we want to mix Thumb and normal ARM code.)
761#ifndef MICROPY_MAKE_POINTER_CALLABLE
762#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
763#endif
764
Damien George7f9d1d62015-04-09 23:56:15 +0100765// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +0000766// must be somehow reachable for marking by the GC, since the native code
767// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +0200768#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +0000769#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 +0200770#endif
771
772#ifndef MP_PLAT_FREE_EXEC
773#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
774#endif
775
Damien George7f9d1d62015-04-09 23:56:15 +0100776// This macro is used to do all output (except when MICROPY_PY_IO is defined)
777#ifndef MP_PLAT_PRINT_STRN
778#define MP_PLAT_PRINT_STRN(str, len) printf("%.*s", (int)len, str)
779#endif
780
Paul Sokolovsky722e5622014-09-06 19:17:23 +0300781#ifndef MP_SSIZE_MAX
782#define MP_SSIZE_MAX SSIZE_MAX
783#endif
784
Damien George40f3c022014-07-03 13:25:24 +0100785// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +0000786#ifndef INT_FMT
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200787#ifdef __LP64__
Damien George40f3c022014-07-03 13:25:24 +0100788// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200789#define UINT_FMT "%lu"
790#define INT_FMT "%ld"
791#else
Damien George40f3c022014-07-03 13:25:24 +0100792// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200793#define UINT_FMT "%u"
794#define INT_FMT "%d"
795#endif
796#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +0300797
798// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +0200799#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +0300800#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +0200801#endif
mux5c8db482014-06-21 17:24:55 +0200802
803// Modifier for weak functions
804#ifndef MP_WEAK
805#define MP_WEAK __attribute__((weak))
806#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +0200807
808// Condition is likely to be true, to help branch prediction
809#ifndef MP_LIKELY
810#define MP_LIKELY(x) __builtin_expect((x), 1)
811#endif
812
813// Condition is likely to be false, to help branch prediction
814#ifndef MP_UNLIKELY
815#define MP_UNLIKELY(x) __builtin_expect((x), 0)
816#endif
Damien George9ddbe292014-12-29 01:02:19 +0000817
818#endif // __MICROPY_INCLUDED_PY_MPCONFIG_H__