blob: 0b86ec435099c23064e17aa1dd9b2c5293296334 [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
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200155// Avoid using C stack when making Python function calls. C stack still
156// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200157#ifndef MICROPY_STACKLESS
158#define MICROPY_STACKLESS (0)
159#endif
160
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200161// Never use C stack when making Python function calls. This may break
162// testsuite as will subtly change which exception is thrown in case
163// of too deep recursion and other similar cases.
164#ifndef MICROPY_STACKLESS_STRICT
165#define MICROPY_STACKLESS_STRICT (0)
166#endif
167
Damien George66e18f02014-05-05 13:19:03 +0100168/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000169/* Micro Python emitters */
170
171// Whether to emit CPython byte codes (for debugging/testing)
172// Enabling this overrides all other emitters
173#ifndef MICROPY_EMIT_CPYTHON
174#define MICROPY_EMIT_CPYTHON (0)
175#endif
176
177// Whether to emit x64 native code
178#ifndef MICROPY_EMIT_X64
179#define MICROPY_EMIT_X64 (0)
180#endif
181
Damien Georgec90f59e2014-09-06 23:06:36 +0100182// Whether to emit x86 native code
183#ifndef MICROPY_EMIT_X86
184#define MICROPY_EMIT_X86 (0)
185#endif
186
Damien George136f6752014-01-07 14:54:15 +0000187// Whether to emit thumb native code
188#ifndef MICROPY_EMIT_THUMB
189#define MICROPY_EMIT_THUMB (0)
190#endif
191
192// Whether to enable the thumb inline assembler
193#ifndef MICROPY_EMIT_INLINE_THUMB
194#define MICROPY_EMIT_INLINE_THUMB (0)
195#endif
196
=50089722015-04-14 13:14:57 +0100197// Whether to enable float support in the Thumb2 inline assembler
198#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
199#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
200#endif
201
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200202// Whether to emit ARM native code
203#ifndef MICROPY_EMIT_ARM
204#define MICROPY_EMIT_ARM (0)
205#endif
206
Damien George2ac4af62014-08-15 16:45:41 +0100207// Convenience definition for whether any native emitter is enabled
Damien Georgec90f59e2014-09-06 23:06:36 +0100208#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM)
Damien George2ac4af62014-08-15 16:45:41 +0100209
Damien George136f6752014-01-07 14:54:15 +0000210/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100211/* Compiler configuration */
212
Damien Georgeddd1e182015-01-10 14:07:24 +0000213// Whether to enable lookup of constants in modules; eg module.CONST
214#ifndef MICROPY_COMP_MODULE_CONST
215#define MICROPY_COMP_MODULE_CONST (0)
216#endif
217
Damien George58ebde42014-05-21 20:32:59 +0100218// Whether to enable constant optimisation; id = const(value)
219#ifndef MICROPY_COMP_CONST
220#define MICROPY_COMP_CONST (1)
221#endif
222
Damien George42e0c592015-03-14 13:11:35 +0000223// Whether to enable optimisation of: a, b = c, d
224// Costs 124 bytes (Thumb2)
225#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
226#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
227#endif
228
229// Whether to enable optimisation of: a, b, c = d, e, f
230// Cost 156 bytes (Thumb2)
231#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
232#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
233#endif
234
Damien George58ebde42014-05-21 20:32:59 +0100235/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000236/* Internal debugging stuff */
237
238// Whether to collect memory allocation stats
239#ifndef MICROPY_MEM_STATS
240#define MICROPY_MEM_STATS (0)
241#endif
242
Damien Georgecbd2f742014-01-19 11:48:48 +0000243// Whether to build functions that print debugging info:
nhtshot5d323de2015-02-23 15:05:32 -0600244// mp_lexer_show_token
Damien George3417bc22014-05-10 10:36:38 +0100245// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000246// mp_parse_node_print
247#ifndef MICROPY_DEBUG_PRINTERS
248#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000249#endif
250
Damien George136f6752014-01-07 14:54:15 +0000251/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100252/* Optimisations */
253
254// Whether to use computed gotos in the VM, or a switch
255// Computed gotos are roughly 10% faster, and increase VM code size by a little
256#ifndef MICROPY_OPT_COMPUTED_GOTO
257#define MICROPY_OPT_COMPUTED_GOTO (0)
258#endif
259
Damien George7ee91cf2015-01-06 12:51:39 +0000260// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
261// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
262// uses a bit of extra code ROM, but greatly improves lookup speed.
263#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
264#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
265#endif
266
Damien Georgeee3fd462014-05-24 23:03:12 +0100267/*****************************************************************************/
268/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000269
Damien Georged3ebe482014-01-07 15:20:33 +0000270// Whether to include the garbage collector
271#ifndef MICROPY_ENABLE_GC
272#define MICROPY_ENABLE_GC (0)
273#endif
274
Damien George12bab722014-04-05 20:35:48 +0100275// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000276#ifndef MICROPY_ENABLE_FINALISER
277#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100278#endif
279
Paul Sokolovsky23668692014-06-25 03:03:34 +0300280// Whether to check C stack usage. C stack used for calling Python functions,
281// etc. Not checking means segfault on overflow.
282#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000283#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300284#endif
285
Dave Hylands5b7fd202014-07-01 23:46:53 -0700286// Whether to have an emergency exception buffer
287#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
288#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
289#endif
290#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
291# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
292# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
293# endif
294#endif
295
Damien George136f6752014-01-07 14:54:15 +0000296// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100297#ifndef MICROPY_HELPER_REPL
298#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000299#endif
300
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200301// Whether port requires event-driven REPL functions
302#ifndef MICROPY_REPL_EVENT_DRIVEN
303#define MICROPY_REPL_EVENT_DRIVEN (0)
304#endif
305
Damien Georged3ebe482014-01-07 15:20:33 +0000306// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100307#ifndef MICROPY_HELPER_LEXER_UNIX
308#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000309#endif
310
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200311// Long int implementation
312#define MICROPY_LONGINT_IMPL_NONE (0)
313#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000314#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200315
316#ifndef MICROPY_LONGINT_IMPL
317#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
318#endif
319
320#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
321typedef long long mp_longint_impl_t;
322#endif
323
Damien George62ad1892014-01-29 21:51:51 +0000324// Whether to include information in the byte code to determine source
325// line number (increases RAM usage, but doesn't slow byte code execution)
326#ifndef MICROPY_ENABLE_SOURCE_LINE
327#define MICROPY_ENABLE_SOURCE_LINE (0)
328#endif
329
Damien George1463c1f2014-04-25 23:52:57 +0100330// Whether to include doc strings (increases RAM usage)
331#ifndef MICROPY_ENABLE_DOC_STRING
332#define MICROPY_ENABLE_DOC_STRING (0)
333#endif
334
Damien George1e9a92f2014-11-06 17:36:16 +0000335// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300336#define MICROPY_ERROR_REPORTING_TERSE (1)
337// Exception messages provide basic error details
338#define MICROPY_ERROR_REPORTING_NORMAL (2)
339// Exception messages provide full info, e.g. object names
340#define MICROPY_ERROR_REPORTING_DETAILED (3)
341
342#ifndef MICROPY_ERROR_REPORTING
343#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
344#endif
345
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200346// Whether issue warnings during compiling/execution
347#ifndef MICROPY_WARNINGS
348#define MICROPY_WARNINGS (0)
349#endif
350
Damien George0c36da02014-03-08 15:24:39 +0000351// Float and complex implementation
352#define MICROPY_FLOAT_IMPL_NONE (0)
353#define MICROPY_FLOAT_IMPL_FLOAT (1)
354#define MICROPY_FLOAT_IMPL_DOUBLE (2)
355
356#ifndef MICROPY_FLOAT_IMPL
357#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
358#endif
359
360#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100361#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000362#define MICROPY_FLOAT_C_FUN(fun) fun##f
363typedef float mp_float_t;
364#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
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
367typedef double mp_float_t;
368#else
Damien Georgefb510b32014-06-01 13:32:54 +0100369#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000370#endif
371
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300372#ifndef MICROPY_PY_BUILTINS_COMPLEX
373#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
374#endif
375
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200376// Enable features which improve CPython compatibility
377// but may lead to more code size/memory usage.
378// TODO: Originally intended as generic category to not
379// add bunch of once-off options. May need refactoring later
380#ifndef MICROPY_CPYTHON_COMPAT
381#define MICROPY_CPYTHON_COMPAT (1)
382#endif
383
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300384// Whether POSIX-semantics non-blocking streams are supported
385#ifndef MICROPY_STREAMS_NON_BLOCK
386#define MICROPY_STREAMS_NON_BLOCK (0)
387#endif
388
Damien Georgec14a8162014-10-12 11:46:04 +0100389// Whether module weak links are supported
390#ifndef MICROPY_MODULE_WEAK_LINKS
391#define MICROPY_MODULE_WEAK_LINKS (0)
392#endif
393
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200394// Whether frozen modules are supported
395#ifndef MICROPY_MODULE_FROZEN
396#define MICROPY_MODULE_FROZEN (0)
397#endif
398
Damien George78d702c2014-12-09 16:19:48 +0000399// Whether you can override builtins in the builtins module
400#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
401#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
402#endif
403
Damien George06593fb2015-06-19 12:49:10 +0000404// Whether to check that the "self" argument of a builtin method has the
405// correct type. Such an explicit check is only needed if a builtin
406// method escapes to Python land without a first argument, eg
407// list.append([], 1). Without this check such calls will have undefined
408// behaviour (usually segfault) if the first argument is the wrong type.
409#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
410#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
411#endif
412
Damien Georgeee3fd462014-05-24 23:03:12 +0100413/*****************************************************************************/
414/* Fine control over Python builtins, classes, modules, etc */
415
stijn3cc17c62015-02-14 18:44:31 +0100416// Whether to implement attributes on functions
417#ifndef MICROPY_PY_FUNCTION_ATTRS
418#define MICROPY_PY_FUNCTION_ATTRS (0)
419#endif
420
stijn28fa84b2015-02-14 18:43:54 +0100421// Whether to support descriptors (__get__ and __set__)
422// This costs some code size and makes all load attrs and store attrs slow
423#ifndef MICROPY_PY_DESCRIPTORS
424#define MICROPY_PY_DESCRIPTORS (0)
425#endif
426
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300427// Whether str object is proper unicode
428#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
429#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100430#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100431
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300432// Whether str.splitlines() method provided
433#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
434#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
435#endif
436
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300437// Whether to support bytearray object
438#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
439#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300440#endif
441
Damien Georgedd4f4532014-10-23 13:34:35 +0100442// Whether to support memoryview object
443#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
444#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
445#endif
446
Damien George3ebd4d02014-06-01 13:46:47 +0100447// Whether to support set object
448#ifndef MICROPY_PY_BUILTINS_SET
449#define MICROPY_PY_BUILTINS_SET (1)
450#endif
451
Damien Georgefb510b32014-06-01 13:32:54 +0100452// Whether to support slice subscript operators and slice object
453#ifndef MICROPY_PY_BUILTINS_SLICE
454#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100455#endif
456
457// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100458#ifndef MICROPY_PY_BUILTINS_FROZENSET
459#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100460#endif
461
Damien Georgefb510b32014-06-01 13:32:54 +0100462// Whether to support property object
463#ifndef MICROPY_PY_BUILTINS_PROPERTY
464#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100465#endif
466
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500467// Whether to implement the start/stop/step attributes (readback) on
468// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
469#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
470#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
471#endif
472
Daniel Campora077812b2015-06-29 22:45:39 +0200473// Whether to support timeout exceptions (like socket.timeout)
474#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
475#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
476#endif
477
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200478// Whether to support complete set of special methods
479// for user classes, otherwise only the most used
480#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
481#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
482#endif
483
Damien Georgec9fc6202014-10-25 21:59:14 +0100484// Whether to support compile function
485#ifndef MICROPY_PY_BUILTINS_COMPILE
486#define MICROPY_PY_BUILTINS_COMPILE (0)
487#endif
488
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300489// Whether to support enumerate function(type)
490#ifndef MICROPY_PY_BUILTINS_ENUMERATE
491#define MICROPY_PY_BUILTINS_ENUMERATE (1)
492#endif
493
Damien George2a3e2b92014-12-19 13:36:17 +0000494// Whether to support the Python 2 execfile function
495#ifndef MICROPY_PY_BUILTINS_EXECFILE
496#define MICROPY_PY_BUILTINS_EXECFILE (0)
497#endif
498
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300499// Whether to support reversed function(type)
500#ifndef MICROPY_PY_BUILTINS_REVERSED
501#define MICROPY_PY_BUILTINS_REVERSED (1)
502#endif
503
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300504// Whether to define "NotImplemented" special constant
505#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
506#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
507#endif
508
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300509// Whether to set __file__ for imported modules
510#ifndef MICROPY_PY___FILE__
511#define MICROPY_PY___FILE__ (1)
512#endif
513
Damien George89deec02015-01-09 20:12:54 +0000514// Whether to provide mem-info related functions in micropython module
515#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
516#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
517#endif
518
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300519// Whether to provide "array" module. Note that large chunk of the
520// underlying code is shared with "bytearray" builtin type, so to
521// get real savings, it should be disabled too.
522#ifndef MICROPY_PY_ARRAY
523#define MICROPY_PY_ARRAY (1)
524#endif
525
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200526// Whether to support slice assignments for array (and bytearray).
527// This is rarely used, but adds ~0.5K of code.
528#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
529#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
530#endif
531
Damien George5aa311d2015-04-21 14:14:24 +0000532// Whether to support attrtuple type (MicroPython extension)
533// It provides space-efficient tuples with attribute access
534#ifndef MICROPY_PY_ATTRTUPLE
535#define MICROPY_PY_ATTRTUPLE (1)
536#endif
537
Damien Georgeee3fd462014-05-24 23:03:12 +0100538// Whether to provide "collections" module
539#ifndef MICROPY_PY_COLLECTIONS
540#define MICROPY_PY_COLLECTIONS (1)
541#endif
542
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200543// Whether to provide "collections.OrderedDict" type
544#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
545#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
546#endif
547
Damien Georgeee3fd462014-05-24 23:03:12 +0100548// Whether to provide "math" module
549#ifndef MICROPY_PY_MATH
550#define MICROPY_PY_MATH (1)
551#endif
552
Damien George5cbeace2015-02-22 14:48:18 +0000553// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
554#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
555#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
556#endif
557
Damien Georgeee3fd462014-05-24 23:03:12 +0100558// Whether to provide "cmath" module
559#ifndef MICROPY_PY_CMATH
560#define MICROPY_PY_CMATH (0)
561#endif
562
563// Whether to provide "gc" module
564#ifndef MICROPY_PY_GC
565#define MICROPY_PY_GC (1)
566#endif
567
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300568// Whether to return number of collected objects from gc.collect()
569#ifndef MICROPY_PY_GC_COLLECT_RETVAL
570#define MICROPY_PY_GC_COLLECT_RETVAL (0)
571#endif
572
Damien Georgeee3fd462014-05-24 23:03:12 +0100573// Whether to provide "io" module
574#ifndef MICROPY_PY_IO
575#define MICROPY_PY_IO (1)
576#endif
577
578// Whether to provide "io.FileIO" class
579#ifndef MICROPY_PY_IO_FILEIO
580#define MICROPY_PY_IO_FILEIO (0)
581#endif
582
583// Whether to provide "io.BytesIO" class
584#ifndef MICROPY_PY_IO_BYTESIO
585#define MICROPY_PY_IO_BYTESIO (1)
586#endif
587
588// Whether to provide "struct" module
589#ifndef MICROPY_PY_STRUCT
590#define MICROPY_PY_STRUCT (1)
591#endif
592
593// Whether to provide "sys" module
594#ifndef MICROPY_PY_SYS
595#define MICROPY_PY_SYS (1)
596#endif
597
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300598// Whether to provide "sys.maxsize" constant
599#ifndef MICROPY_PY_SYS_MAXSIZE
600#define MICROPY_PY_SYS_MAXSIZE (0)
601#endif
602
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300603// Whether to provide "sys.exc_info" function
604// Avoid enabling this, this function is Python2 heritage
605#ifndef MICROPY_PY_SYS_EXC_INFO
606#define MICROPY_PY_SYS_EXC_INFO (0)
607#endif
608
Damien Georgeee3fd462014-05-24 23:03:12 +0100609// Whether to provide "sys.exit" function
610#ifndef MICROPY_PY_SYS_EXIT
611#define MICROPY_PY_SYS_EXIT (0)
612#endif
613
614// Whether to provide sys.{stdin,stdout,stderr} objects
615#ifndef MICROPY_PY_SYS_STDFILES
616#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100617#endif
618
Damien George3c4b5d42015-05-13 23:49:21 +0100619// Whether to provide sys.{stdin,stdout,stderr}.buffer object
620// This is implemented per-port
621#ifndef MICROPY_PY_SYS_STDIO_BUFFER
622#define MICROPY_PY_SYS_STDIO_BUFFER (0)
623#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300624
625// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +0300626
Paul Sokolovsky82158472014-06-28 03:03:47 +0300627#ifndef MICROPY_PY_UCTYPES
628#define MICROPY_PY_UCTYPES (0)
629#endif
630
Paul Sokolovsky34162872014-10-12 08:16:34 -0700631#ifndef MICROPY_PY_UZLIB
632#define MICROPY_PY_UZLIB (0)
633#endif
634
Damien George612045f2014-09-17 22:56:34 +0100635#ifndef MICROPY_PY_UJSON
636#define MICROPY_PY_UJSON (0)
637#endif
638
Paul Sokolovskyc71e0452014-09-12 18:48:07 +0300639#ifndef MICROPY_PY_URE
640#define MICROPY_PY_URE (0)
641#endif
642
Damien Georgef5d69792014-10-22 17:37:18 +0000643#ifndef MICROPY_PY_UHEAPQ
644#define MICROPY_PY_UHEAPQ (0)
645#endif
646
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +0200647#ifndef MICROPY_PY_UHASHLIB
648#define MICROPY_PY_UHASHLIB (0)
649#endif
650
Paul Sokolovskybfdc2052014-11-29 06:19:30 +0200651#ifndef MICROPY_PY_UBINASCII
652#define MICROPY_PY_UBINASCII (0)
653#endif
654
Paul Sokolovsky01162182015-05-03 20:25:40 +0300655#ifndef MICROPY_PY_MACHINE
656#define MICROPY_PY_MACHINE (0)
657#endif
658
Damien George58ebde42014-05-21 20:32:59 +0100659/*****************************************************************************/
660/* Hooks for a port to add builtins */
661
Damien Georgecaac5422014-03-25 14:18:18 +0000662// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100663#ifndef MICROPY_PORT_BUILTINS
664#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +0200665#endif
Damien Georgecaac5422014-03-25 14:18:18 +0000666
667// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100668#ifndef MICROPY_PORT_BUILTIN_MODULES
669#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +0000670#endif
671
Damien Georgec14a8162014-10-12 11:46:04 +0100672// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
673#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
674#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
675#endif
676
Damien George57e99eb2014-04-10 22:42:11 +0100677// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +0100678#ifndef MICROPY_PORT_CONSTANTS
679#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +0100680#endif
681
Damien Georgeb4b10fd2015-01-01 23:30:53 +0000682// Any root pointers for GC scanning - see mpstate.c
683#ifndef MICROPY_PORT_ROOT_POINTERS
684#define MICROPY_PORT_ROOT_POINTERS
685#endif
686
Damien George136f6752014-01-07 14:54:15 +0000687/*****************************************************************************/
688/* Miscellaneous settings */
689
Damien George28631532015-02-08 13:42:00 +0000690// All uPy objects in ROM must be aligned on at least a 4 byte boundary
691// so that the small-int/qstr/pointer distinction can be made. For machines
692// that don't do this (eg 16-bit CPU), define the following macro to something
693// like __attribute__((aligned(4))).
694#ifndef MICROPY_OBJ_BASE_ALIGNMENT
695#define MICROPY_OBJ_BASE_ALIGNMENT
696#endif
697
Dave Hylands5b7fd202014-07-01 23:46:53 -0700698// On embedded platforms, these will typically enable/disable irqs.
699#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000700#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700701#endif
702#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000703#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700704#endif
705
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200706// Allow to override static modifier for global objects, e.g. to use with
707// object code analysis tools which don't support static symbols.
708#ifndef STATIC
709#define STATIC static
710#endif
711
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200712#define BITS_PER_BYTE (8)
713#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +0100714// mp_int_t value with most significant bit set
715#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200716
Damien Georgea9bcd512014-10-06 13:44:59 +0000717// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
718// defined and that they are the opposite of each other.
719#if defined(MP_ENDIANNESS_LITTLE)
720#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
721#elif defined(MP_ENDIANNESS_BIG)
722#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
723#else
724 // Endiannes not defined by port so try to autodetect it.
725 #if defined(__BYTE_ORDER__)
726 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
727 #define MP_ENDIANNESS_LITTLE (1)
728 #else
729 #define MP_ENDIANNESS_LITTLE (0)
730 #endif
Damien Georgef32498f2014-10-06 16:09:31 +0000731 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
732 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +0000733 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
734 #define MP_ENDIANNESS_LITTLE (0)
735 #else
Damien George4e4772b2015-05-30 23:12:30 +0100736 #include <endian.h>
737 #if defined(__BYTE_ORDER)
738 #if __BYTE_ORDER == __LITTLE_ENDIAN
739 #define MP_ENDIANNESS_LITTLE (1)
740 #else
741 #define MP_ENDIANNESS_LITTLE (0)
742 #endif
743 #else
744 #error endianness not defined and cannot detect it
745 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +0000746 #endif
747 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +0100748#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +0300749
Damien George3c658a42014-08-24 16:28:17 +0100750// Make a pointer to RAM callable (eg set lower bit for Thumb code)
751// (This scheme won't work if we want to mix Thumb and normal ARM code.)
752#ifndef MICROPY_MAKE_POINTER_CALLABLE
753#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
754#endif
755
Damien George7f9d1d62015-04-09 23:56:15 +0100756// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +0000757// must be somehow reachable for marking by the GC, since the native code
758// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +0200759#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +0000760#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 +0200761#endif
762
763#ifndef MP_PLAT_FREE_EXEC
764#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
765#endif
766
Damien George7f9d1d62015-04-09 23:56:15 +0100767// This macro is used to do all output (except when MICROPY_PY_IO is defined)
768#ifndef MP_PLAT_PRINT_STRN
769#define MP_PLAT_PRINT_STRN(str, len) printf("%.*s", (int)len, str)
770#endif
771
Paul Sokolovsky722e5622014-09-06 19:17:23 +0300772#ifndef MP_SSIZE_MAX
773#define MP_SSIZE_MAX SSIZE_MAX
774#endif
775
Damien George40f3c022014-07-03 13:25:24 +0100776// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +0000777#ifndef INT_FMT
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200778#ifdef __LP64__
Damien George40f3c022014-07-03 13:25:24 +0100779// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200780#define UINT_FMT "%lu"
781#define INT_FMT "%ld"
782#else
Damien George40f3c022014-07-03 13:25:24 +0100783// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200784#define UINT_FMT "%u"
785#define INT_FMT "%d"
786#endif
787#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +0300788
789// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +0200790#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +0300791#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +0200792#endif
mux5c8db482014-06-21 17:24:55 +0200793
794// Modifier for weak functions
795#ifndef MP_WEAK
796#define MP_WEAK __attribute__((weak))
797#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +0200798
799// Condition is likely to be true, to help branch prediction
800#ifndef MP_LIKELY
801#define MP_LIKELY(x) __builtin_expect((x), 1)
802#endif
803
804// Condition is likely to be false, to help branch prediction
805#ifndef MP_UNLIKELY
806#define MP_UNLIKELY(x) __builtin_expect((x), 0)
807#endif
Damien George9ddbe292014-12-29 01:02:19 +0000808
809#endif // __MICROPY_INCLUDED_PY_MPCONFIG_H__