blob: 5e717ad0f68b18b65661983d6986a6216dbc27af [file] [log] [blame]
Damien George04b91472014-05-03 23:27:38 +01001/*
2 * This file is part of the Micro Python project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2013, 2014 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
Damien George9ddbe292014-12-29 01:02:19 +000026#ifndef __MICROPY_INCLUDED_PY_MPCONFIG_H__
27#define __MICROPY_INCLUDED_PY_MPCONFIG_H__
Damien George04b91472014-05-03 23:27:38 +010028
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020029// This file contains default configuration settings for MicroPython.
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020030// You can override any of the options below using mpconfigport.h file
31// located in a directory of your port.
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020032
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020033// mpconfigport.h is a file containing configuration settings for a
34// particular port. mpconfigport.h is actually a default name for
35// such config, and it can be overriden using MP_CONFIGFILE preprocessor
36// define (you can do that by passing CFLAGS_EXTRA='-DMP_CONFIGFILE="<file.h>"'
37// argument to make when using standard MicroPython makefiles).
38// This is useful to have more than one config per port, for example,
39// release vs debug configs, etc. Note that if you switch from one config
40// to another, you must rebuild from scratch using "-B" switch to make.
41
42#ifdef MP_CONFIGFILE
43#include MP_CONFIGFILE
44#else
Damien George8340c482014-06-12 19:50:17 +010045#include <mpconfigport.h>
Paul Sokolovskyb1422de2014-10-29 04:08:49 +020046#endif
Paul Sokolovskyb372bfc2014-01-03 17:15:53 +020047
Damien George136f6752014-01-07 14:54:15 +000048// Any options not explicitly set in mpconfigport.h will get default
49// values below.
50
51/*****************************************************************************/
Damien George567184e2015-03-29 14:05:46 +010052/* Object representation */
53
54// A Micro Python object is a machine word having the following form:
55// - xxxx...xxx1 : a small int, bits 1 and above are the value
56// - xxxx...xx10 : a qstr, bits 2 and above are the value
57// - xxxx...xx00 : a pointer to an mp_obj_base_t (unless a fake object)
58#define MICROPY_OBJ_REPR_A (0)
59
60// A Micro Python object is a machine word having the following form:
61// - xxxx...xx01 : a small int, bits 2 and above are the value
62// - xxxx...xx11 : a qstr, bits 2 and above are the value
63// - xxxx...xxx0 : a pointer to an mp_obj_base_t (unless a fake object)
64#define MICROPY_OBJ_REPR_B (1)
65
Damien George8b8d1892015-11-06 23:25:10 +000066// A MicroPython object is a machine word having the following form (called R):
Damien George183edef2015-10-17 23:20:57 +010067// - iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int with 31-bit signed value
Damien George8b8d1892015-11-06 23:25:10 +000068// - 01111111 1qqqqqqq qqqqqqqq qqqqq110 str with 20-bit qstr value
Damien George183edef2015-10-17 23:20:57 +010069// - s1111111 10000000 00000000 00000010 +/- inf
70// - s1111111 1xxxxxxx xxxxxxxx xxxxx010 nan, x != 0
71// - seeeeeee efffffff ffffffff ffffff10 30-bit fp, e != 0xff
72// - pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
Damien George8b8d1892015-11-06 23:25:10 +000073// Str and float stored as O = R + 0x80800000, retrieved as R = O - 0x80800000.
74// This makes strs easier to encode/decode as they have zeros in the top 9 bits.
Damien George183edef2015-10-17 23:20:57 +010075// This scheme only works with 32-bit word size and float enabled.
Damien George8b8d1892015-11-06 23:25:10 +000076
Damien George183edef2015-10-17 23:20:57 +010077#define MICROPY_OBJ_REPR_C (2)
78
Damien Georgeb8cfb0d2015-11-27 17:09:11 +000079// A MicroPython object is a 64-bit word having the following form (called R):
80// - seeeeeee eeeeffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff 64-bit fp, e != 0x7ff
81// - s1111111 11110000 00000000 00000000 00000000 00000000 00000000 00000000 +/- inf
82// - 01111111 11111000 00000000 00000000 00000000 00000000 00000000 00000000 normalised nan
83// - 01111111 11111101 00000000 00000000 iiiiiiii iiiiiiii iiiiiiii iiiiiii1 small int
84// - 01111111 11111110 00000000 00000000 qqqqqqqq qqqqqqqq qqqqqqqq qqqqqqq1 str
85// - 01111111 11111100 00000000 00000000 pppppppp pppppppp pppppppp pppppp00 ptr (4 byte alignment)
86// Stored as O = R + 0x8004000000000000, retrieved as R = O - 0x8004000000000000.
87// This makes pointers have all zeros in the top 32 bits.
88// Small-ints and strs have 1 as LSB to make sure they don't look like pointers
89// to the garbage collector.
90#define MICROPY_OBJ_REPR_D (3)
91
Damien George567184e2015-03-29 14:05:46 +010092#ifndef MICROPY_OBJ_REPR
93#define MICROPY_OBJ_REPR (MICROPY_OBJ_REPR_A)
94#endif
95
96/*****************************************************************************/
Damien George66e18f02014-05-05 13:19:03 +010097/* Memory allocation policy */
98
Paul Sokolovsky75feece2015-12-03 01:40:52 +020099// Number of bytes in memory allocation/GC block. Any size allocated will be
100// rounded up to be multiples of this.
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200101#ifndef MICROPY_BYTES_PER_GC_BLOCK
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200102#define MICROPY_BYTES_PER_GC_BLOCK (4 * BYTES_PER_WORD)
Paul Sokolovskyb4eccfd2015-12-03 01:57:50 +0200103#endif
Paul Sokolovsky75feece2015-12-03 01:40:52 +0200104
Damien Georgefd40a9c2015-01-01 22:04:46 +0000105// Number of words allocated (in BSS) to the GC stack (minimum is 1)
106#ifndef MICROPY_ALLOC_GC_STACK_SIZE
107#define MICROPY_ALLOC_GC_STACK_SIZE (64)
108#endif
109
Damien Georgeade9a052015-06-13 21:53:22 +0100110// Number of bytes to allocate initially when creating new chunks to store
111// interned string data. Smaller numbers lead to more chunks being needed
112// and more wastage at the end of the chunk. Larger numbers lead to wasted
113// space at the end when no more strings need interning.
114#ifndef MICROPY_ALLOC_QSTR_CHUNK_INIT
115#define MICROPY_ALLOC_QSTR_CHUNK_INIT (128)
116#endif
117
Damien Georgee1199ec2014-05-10 17:48:01 +0100118// Initial amount for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100119#ifndef MICROPY_ALLOC_LEXER_INDENT_INIT
120#define MICROPY_ALLOC_LEXER_INDENT_INIT (10)
Damien Georgee1199ec2014-05-10 17:48:01 +0100121#endif
122
123// Increment for lexer indentation level
Damien George58ebde42014-05-21 20:32:59 +0100124#ifndef MICROPY_ALLOC_LEXEL_INDENT_INC
125#define MICROPY_ALLOC_LEXEL_INDENT_INC (8)
Damien Georgee1199ec2014-05-10 17:48:01 +0100126#endif
127
Damien George66e18f02014-05-05 13:19:03 +0100128// Initial amount for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100129#ifndef MICROPY_ALLOC_PARSE_RULE_INIT
130#define MICROPY_ALLOC_PARSE_RULE_INIT (64)
Damien George66e18f02014-05-05 13:19:03 +0100131#endif
132
133// Increment for parse rule stack
Damien George58ebde42014-05-21 20:32:59 +0100134#ifndef MICROPY_ALLOC_PARSE_RULE_INC
135#define MICROPY_ALLOC_PARSE_RULE_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100136#endif
137
138// Initial amount for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100139#ifndef MICROPY_ALLOC_PARSE_RESULT_INIT
140#define MICROPY_ALLOC_PARSE_RESULT_INIT (32)
Damien George66e18f02014-05-05 13:19:03 +0100141#endif
142
143// Increment for parse result stack
Damien George58ebde42014-05-21 20:32:59 +0100144#ifndef MICROPY_ALLOC_PARSE_RESULT_INC
145#define MICROPY_ALLOC_PARSE_RESULT_INC (16)
Damien George66e18f02014-05-05 13:19:03 +0100146#endif
147
Damien George5042bce2014-05-25 22:06:06 +0100148// Strings this length or less will be interned by the parser
149#ifndef MICROPY_ALLOC_PARSE_INTERN_STRING_LEN
150#define MICROPY_ALLOC_PARSE_INTERN_STRING_LEN (10)
151#endif
152
Damien George58e0f4a2015-09-23 10:50:43 +0100153// Number of bytes to allocate initially when creating new chunks to store
154// parse nodes. Small leads to fragmentation, large leads to excess use.
155#ifndef MICROPY_ALLOC_PARSE_CHUNK_INIT
156#define MICROPY_ALLOC_PARSE_CHUNK_INIT (128)
157#endif
158
Damien George66e18f02014-05-05 13:19:03 +0100159// Initial amount for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100160#ifndef MICROPY_ALLOC_SCOPE_ID_INIT
161#define MICROPY_ALLOC_SCOPE_ID_INIT (4)
Damien George66e18f02014-05-05 13:19:03 +0100162#endif
163
164// Increment for ids in a scope
Damien George58ebde42014-05-21 20:32:59 +0100165#ifndef MICROPY_ALLOC_SCOPE_ID_INC
166#define MICROPY_ALLOC_SCOPE_ID_INC (6)
167#endif
168
169// Maximum length of a path in the filesystem
170// So we can allocate a buffer on the stack for path manipulation in import
171#ifndef MICROPY_ALLOC_PATH_MAX
172#define MICROPY_ALLOC_PATH_MAX (512)
Damien George66e18f02014-05-05 13:19:03 +0100173#endif
174
Paul Sokolovsky346aacf2014-11-05 00:27:15 +0200175// Initial size of module dict
176#ifndef MICROPY_MODULE_DICT_SIZE
177#define MICROPY_MODULE_DICT_SIZE (1)
178#endif
179
Damien Georged8914522015-02-27 09:54:12 +0000180// Whether realloc/free should be passed allocated memory region size
181// You must enable this if MICROPY_MEM_STATS is enabled
182#ifndef MICROPY_MALLOC_USES_ALLOCATED_SIZE
183#define MICROPY_MALLOC_USES_ALLOCATED_SIZE (0)
184#endif
185
Damien George95836f82015-01-11 22:27:30 +0000186// Number of bytes used to store qstr length
187// Dictates hard limit on maximum Python identifier length, but 1 byte
188// (limit of 255 bytes in an identifier) should be enough for everyone
189#ifndef MICROPY_QSTR_BYTES_IN_LEN
190#define MICROPY_QSTR_BYTES_IN_LEN (1)
191#endif
192
Damien Georgec3bd9412015-07-20 11:03:13 +0000193// Number of bytes used to store qstr hash
194#ifndef MICROPY_QSTR_BYTES_IN_HASH
195#define MICROPY_QSTR_BYTES_IN_HASH (2)
196#endif
197
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200198// Avoid using C stack when making Python function calls. C stack still
199// may be used if there's no free heap.
Paul Sokolovsky20397572015-03-28 01:14:44 +0200200#ifndef MICROPY_STACKLESS
201#define MICROPY_STACKLESS (0)
202#endif
203
Paul Sokolovsky7f1c9812015-03-28 01:14:45 +0200204// Never use C stack when making Python function calls. This may break
205// testsuite as will subtly change which exception is thrown in case
206// of too deep recursion and other similar cases.
207#ifndef MICROPY_STACKLESS_STRICT
208#define MICROPY_STACKLESS_STRICT (0)
209#endif
210
Paul Sokolovskyf32020e2015-11-25 23:22:31 +0200211// Don't use alloca calls. As alloca() is not part of ANSI C, this
212// workaround option is provided for compilers lacking this de-facto
213// standard function. The way it works is allocating from heap, and
214// relying on garbage collection to free it eventually. This is of
215// course much less optimal than real alloca().
216#if defined(MICROPY_NO_ALLOCA) && MICROPY_NO_ALLOCA
217#undef alloca
218#define alloca(x) m_malloc(x)
219#endif
220
Damien George66e18f02014-05-05 13:19:03 +0100221/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000222/* Micro Python emitters */
223
Damien Georged8c834c2015-11-02 21:55:42 +0000224// Whether to support loading of persistent code
225#ifndef MICROPY_PERSISTENT_CODE_LOAD
226#define MICROPY_PERSISTENT_CODE_LOAD (0)
227#endif
228
229// Whether to support saving of persistent code
230#ifndef MICROPY_PERSISTENT_CODE_SAVE
231#define MICROPY_PERSISTENT_CODE_SAVE (0)
232#endif
233
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000234// Whether generated code can persist independently of the VM/runtime instance
Damien Georged8c834c2015-11-02 21:55:42 +0000235// This is enabled automatically when needed by other features
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000236#ifndef MICROPY_PERSISTENT_CODE
Damien Georged8c834c2015-11-02 21:55:42 +0000237#define MICROPY_PERSISTENT_CODE (MICROPY_PERSISTENT_CODE_LOAD || MICROPY_PERSISTENT_CODE_SAVE)
Damien Georgec8e9c0d2015-11-02 17:27:18 +0000238#endif
239
Damien George136f6752014-01-07 14:54:15 +0000240// Whether to emit x64 native code
241#ifndef MICROPY_EMIT_X64
242#define MICROPY_EMIT_X64 (0)
243#endif
244
Damien Georgec90f59e2014-09-06 23:06:36 +0100245// Whether to emit x86 native code
246#ifndef MICROPY_EMIT_X86
247#define MICROPY_EMIT_X86 (0)
248#endif
249
Damien George136f6752014-01-07 14:54:15 +0000250// Whether to emit thumb native code
251#ifndef MICROPY_EMIT_THUMB
252#define MICROPY_EMIT_THUMB (0)
253#endif
254
255// Whether to enable the thumb inline assembler
256#ifndef MICROPY_EMIT_INLINE_THUMB
257#define MICROPY_EMIT_INLINE_THUMB (0)
258#endif
259
Damien Georgee8135412015-10-16 22:08:57 +0100260// Whether to enable ARMv7-M instruction support in the Thumb2 inline assembler
261#ifndef MICROPY_EMIT_INLINE_THUMB_ARMV7M
262#define MICROPY_EMIT_INLINE_THUMB_ARMV7M (1)
263#endif
264
=50089722015-04-14 13:14:57 +0100265// Whether to enable float support in the Thumb2 inline assembler
266#ifndef MICROPY_EMIT_INLINE_THUMB_FLOAT
267#define MICROPY_EMIT_INLINE_THUMB_FLOAT (1)
268#endif
269
Fabian Vogtfe3d16e2014-08-16 22:55:53 +0200270// Whether to emit ARM native code
271#ifndef MICROPY_EMIT_ARM
272#define MICROPY_EMIT_ARM (0)
273#endif
274
Damien George2ac4af62014-08-15 16:45:41 +0100275// Convenience definition for whether any native emitter is enabled
Damien Georgec90f59e2014-09-06 23:06:36 +0100276#define MICROPY_EMIT_NATIVE (MICROPY_EMIT_X64 || MICROPY_EMIT_X86 || MICROPY_EMIT_THUMB || MICROPY_EMIT_ARM)
Damien George2ac4af62014-08-15 16:45:41 +0100277
Damien George136f6752014-01-07 14:54:15 +0000278/*****************************************************************************/
Damien George58ebde42014-05-21 20:32:59 +0100279/* Compiler configuration */
280
Damien Georgedd5353a2015-12-18 12:35:44 +0000281// Whether to include the compiler
282#ifndef MICROPY_ENABLE_COMPILER
283#define MICROPY_ENABLE_COMPILER (1)
284#endif
285
Damien George64f2b212015-10-08 14:58:15 +0100286// Whether to enable constant folding; eg 1+2 rewritten as 3
287#ifndef MICROPY_COMP_CONST_FOLDING
288#define MICROPY_COMP_CONST_FOLDING (1)
289#endif
290
Damien Georgeddd1e182015-01-10 14:07:24 +0000291// Whether to enable lookup of constants in modules; eg module.CONST
292#ifndef MICROPY_COMP_MODULE_CONST
293#define MICROPY_COMP_MODULE_CONST (0)
294#endif
295
Damien George58ebde42014-05-21 20:32:59 +0100296// Whether to enable constant optimisation; id = const(value)
297#ifndef MICROPY_COMP_CONST
298#define MICROPY_COMP_CONST (1)
299#endif
300
Damien George42e0c592015-03-14 13:11:35 +0000301// Whether to enable optimisation of: a, b = c, d
302// Costs 124 bytes (Thumb2)
303#ifndef MICROPY_COMP_DOUBLE_TUPLE_ASSIGN
304#define MICROPY_COMP_DOUBLE_TUPLE_ASSIGN (1)
305#endif
306
307// Whether to enable optimisation of: a, b, c = d, e, f
308// Cost 156 bytes (Thumb2)
309#ifndef MICROPY_COMP_TRIPLE_TUPLE_ASSIGN
310#define MICROPY_COMP_TRIPLE_TUPLE_ASSIGN (0)
311#endif
312
Damien George58ebde42014-05-21 20:32:59 +0100313/*****************************************************************************/
Damien George136f6752014-01-07 14:54:15 +0000314/* Internal debugging stuff */
315
316// Whether to collect memory allocation stats
317#ifndef MICROPY_MEM_STATS
318#define MICROPY_MEM_STATS (0)
319#endif
320
Damien Georgecbd2f742014-01-19 11:48:48 +0000321// Whether to build functions that print debugging info:
nhtshot5d323de2015-02-23 15:05:32 -0600322// mp_lexer_show_token
Damien George3417bc22014-05-10 10:36:38 +0100323// mp_bytecode_print
Damien Georgecbd2f742014-01-19 11:48:48 +0000324// mp_parse_node_print
325#ifndef MICROPY_DEBUG_PRINTERS
326#define MICROPY_DEBUG_PRINTERS (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000327#endif
328
Damien George136f6752014-01-07 14:54:15 +0000329/*****************************************************************************/
Damien Georgeee3fd462014-05-24 23:03:12 +0100330/* Optimisations */
331
332// Whether to use computed gotos in the VM, or a switch
333// Computed gotos are roughly 10% faster, and increase VM code size by a little
334#ifndef MICROPY_OPT_COMPUTED_GOTO
335#define MICROPY_OPT_COMPUTED_GOTO (0)
336#endif
337
Damien George7ee91cf2015-01-06 12:51:39 +0000338// Whether to cache result of map lookups in LOAD_NAME, LOAD_GLOBAL, LOAD_ATTR,
339// STORE_ATTR bytecodes. Uses 1 byte extra RAM for each of these opcodes and
340// uses a bit of extra code ROM, but greatly improves lookup speed.
341#ifndef MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE
342#define MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE (0)
343#endif
344
Damien Georgeee3fd462014-05-24 23:03:12 +0100345/*****************************************************************************/
346/* Python internal features */
Damien George136f6752014-01-07 14:54:15 +0000347
Damien Georged3ebe482014-01-07 15:20:33 +0000348// Whether to include the garbage collector
349#ifndef MICROPY_ENABLE_GC
350#define MICROPY_ENABLE_GC (0)
351#endif
352
Damien George12bab722014-04-05 20:35:48 +0100353// Whether to enable finalisers in the garbage collector (ie call __del__)
Damien George7860c2a2014-11-05 21:16:41 +0000354#ifndef MICROPY_ENABLE_FINALISER
355#define MICROPY_ENABLE_FINALISER (0)
Damien George12bab722014-04-05 20:35:48 +0100356#endif
357
Paul Sokolovsky23668692014-06-25 03:03:34 +0300358// Whether to check C stack usage. C stack used for calling Python functions,
359// etc. Not checking means segfault on overflow.
360#ifndef MICROPY_STACK_CHECK
Damien George4a5895c2015-01-09 00:10:55 +0000361#define MICROPY_STACK_CHECK (0)
Paul Sokolovsky23668692014-06-25 03:03:34 +0300362#endif
363
Dave Hylands5b7fd202014-07-01 23:46:53 -0700364// Whether to have an emergency exception buffer
365#ifndef MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
366#define MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF (0)
367#endif
368#if MICROPY_ENABLE_EMERGENCY_EXCEPTION_BUF
369# ifndef MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE
370# define MICROPY_EMERGENCY_EXCEPTION_BUF_SIZE (0) // 0 - implies dynamic allocation
371# endif
372#endif
373
Paul Sokolovsky1c9210b2015-12-23 00:06:37 +0200374// Prefer to raise KeyboardInterrupt asynchronously (from signal or interrupt
375// handler) - if supported by a particular port.
376#ifndef MICROPY_ASYNC_KBD_INTR
377#define MICROPY_ASYNC_KBD_INTR (0)
378#endif
379
Damien George136f6752014-01-07 14:54:15 +0000380// Whether to include REPL helper function
Damien George58ebde42014-05-21 20:32:59 +0100381#ifndef MICROPY_HELPER_REPL
382#define MICROPY_HELPER_REPL (0)
Damien George136f6752014-01-07 14:54:15 +0000383#endif
384
Tom Soulanille7d588b02015-07-09 16:32:36 -0700385// Whether to include emacs-style readline behavior in REPL
386#ifndef MICROPY_REPL_EMACS_KEYS
Damien Georged8a7f8b2015-07-26 15:49:13 +0100387#define MICROPY_REPL_EMACS_KEYS (0)
Tom Soulanille7d588b02015-07-09 16:32:36 -0700388#endif
389
Damien George0af73012015-08-20 10:34:16 +0100390// Whether to implement auto-indent in REPL
391#ifndef MICROPY_REPL_AUTO_INDENT
392#define MICROPY_REPL_AUTO_INDENT (0)
393#endif
394
Paul Sokolovsky87bc8e22015-01-15 10:46:27 +0200395// Whether port requires event-driven REPL functions
396#ifndef MICROPY_REPL_EVENT_DRIVEN
397#define MICROPY_REPL_EVENT_DRIVEN (0)
398#endif
399
Damien Georged3ebe482014-01-07 15:20:33 +0000400// Whether to include lexer helper function for unix
Damien George58ebde42014-05-21 20:32:59 +0100401#ifndef MICROPY_HELPER_LEXER_UNIX
402#define MICROPY_HELPER_LEXER_UNIX (0)
Damien Georged3ebe482014-01-07 15:20:33 +0000403#endif
404
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200405// Long int implementation
406#define MICROPY_LONGINT_IMPL_NONE (0)
407#define MICROPY_LONGINT_IMPL_LONGLONG (1)
Damien George438c88d2014-02-22 19:25:23 +0000408#define MICROPY_LONGINT_IMPL_MPZ (2)
Paul Sokolovsky48b35722014-01-12 17:30:48 +0200409
410#ifndef MICROPY_LONGINT_IMPL
411#define MICROPY_LONGINT_IMPL (MICROPY_LONGINT_IMPL_NONE)
412#endif
413
414#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
415typedef long long mp_longint_impl_t;
416#endif
417
Damien George62ad1892014-01-29 21:51:51 +0000418// Whether to include information in the byte code to determine source
419// line number (increases RAM usage, but doesn't slow byte code execution)
420#ifndef MICROPY_ENABLE_SOURCE_LINE
421#define MICROPY_ENABLE_SOURCE_LINE (0)
422#endif
423
Damien George1463c1f2014-04-25 23:52:57 +0100424// Whether to include doc strings (increases RAM usage)
425#ifndef MICROPY_ENABLE_DOC_STRING
426#define MICROPY_ENABLE_DOC_STRING (0)
427#endif
428
Damien George1e9a92f2014-11-06 17:36:16 +0000429// Exception messages are short static strings
Paul Sokolovsky1f85d622014-05-01 01:35:38 +0300430#define MICROPY_ERROR_REPORTING_TERSE (1)
431// Exception messages provide basic error details
432#define MICROPY_ERROR_REPORTING_NORMAL (2)
433// Exception messages provide full info, e.g. object names
434#define MICROPY_ERROR_REPORTING_DETAILED (3)
435
436#ifndef MICROPY_ERROR_REPORTING
437#define MICROPY_ERROR_REPORTING (MICROPY_ERROR_REPORTING_NORMAL)
438#endif
439
Paul Sokolovsky8a8c1fc2015-01-01 09:29:28 +0200440// Whether issue warnings during compiling/execution
441#ifndef MICROPY_WARNINGS
442#define MICROPY_WARNINGS (0)
443#endif
444
Damien George0c36da02014-03-08 15:24:39 +0000445// Float and complex implementation
446#define MICROPY_FLOAT_IMPL_NONE (0)
447#define MICROPY_FLOAT_IMPL_FLOAT (1)
448#define MICROPY_FLOAT_IMPL_DOUBLE (2)
449
450#ifndef MICROPY_FLOAT_IMPL
451#define MICROPY_FLOAT_IMPL (MICROPY_FLOAT_IMPL_NONE)
452#endif
453
454#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
Damien Georgefb510b32014-06-01 13:32:54 +0100455#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000456#define MICROPY_FLOAT_C_FUN(fun) fun##f
457typedef float mp_float_t;
458#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
Damien Georgefb510b32014-06-01 13:32:54 +0100459#define MICROPY_PY_BUILTINS_FLOAT (1)
Damien George0c36da02014-03-08 15:24:39 +0000460#define MICROPY_FLOAT_C_FUN(fun) fun
461typedef double mp_float_t;
462#else
Damien Georgefb510b32014-06-01 13:32:54 +0100463#define MICROPY_PY_BUILTINS_FLOAT (0)
Damien George136f6752014-01-07 14:54:15 +0000464#endif
465
Paul Sokolovsky3b6f7b92014-06-20 01:48:35 +0300466#ifndef MICROPY_PY_BUILTINS_COMPLEX
467#define MICROPY_PY_BUILTINS_COMPLEX (MICROPY_PY_BUILTINS_FLOAT)
468#endif
469
Paul Sokolovskydcac8802014-01-16 19:19:50 +0200470// Enable features which improve CPython compatibility
471// but may lead to more code size/memory usage.
472// TODO: Originally intended as generic category to not
473// add bunch of once-off options. May need refactoring later
474#ifndef MICROPY_CPYTHON_COMPAT
475#define MICROPY_CPYTHON_COMPAT (1)
476#endif
477
Paul Sokolovsky0ef015b2014-05-07 02:23:46 +0300478// Whether POSIX-semantics non-blocking streams are supported
479#ifndef MICROPY_STREAMS_NON_BLOCK
480#define MICROPY_STREAMS_NON_BLOCK (0)
481#endif
482
Damien George3c9c3682015-09-15 14:56:13 +0100483// Whether to call __init__ when importing builtin modules for the first time
484#ifndef MICROPY_MODULE_BUILTIN_INIT
485#define MICROPY_MODULE_BUILTIN_INIT (0)
486#endif
487
Damien Georgec14a8162014-10-12 11:46:04 +0100488// Whether module weak links are supported
489#ifndef MICROPY_MODULE_WEAK_LINKS
490#define MICROPY_MODULE_WEAK_LINKS (0)
491#endif
492
Paul Sokolovsky640e0b22015-01-20 11:52:12 +0200493// Whether frozen modules are supported
494#ifndef MICROPY_MODULE_FROZEN
495#define MICROPY_MODULE_FROZEN (0)
496#endif
497
Damien George78d702c2014-12-09 16:19:48 +0000498// Whether you can override builtins in the builtins module
499#ifndef MICROPY_CAN_OVERRIDE_BUILTINS
500#define MICROPY_CAN_OVERRIDE_BUILTINS (0)
501#endif
502
Damien George06593fb2015-06-19 12:49:10 +0000503// Whether to check that the "self" argument of a builtin method has the
504// correct type. Such an explicit check is only needed if a builtin
505// method escapes to Python land without a first argument, eg
506// list.append([], 1). Without this check such calls will have undefined
507// behaviour (usually segfault) if the first argument is the wrong type.
508#ifndef MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG
509#define MICROPY_BUILTIN_METHOD_CHECK_SELF_ARG (1)
510#endif
511
Paul Sokolovskyf0fbab72015-11-25 00:43:11 +0200512// Support for user-space VFS mount (selected ports)
513#ifndef MICROPY_FSUSERMOUNT
514#define MICROPY_FSUSERMOUNT (0)
515#endif
516
Damien Georgeee3fd462014-05-24 23:03:12 +0100517/*****************************************************************************/
518/* Fine control over Python builtins, classes, modules, etc */
519
stijn3cc17c62015-02-14 18:44:31 +0100520// Whether to implement attributes on functions
521#ifndef MICROPY_PY_FUNCTION_ATTRS
522#define MICROPY_PY_FUNCTION_ATTRS (0)
523#endif
524
stijn28fa84b2015-02-14 18:43:54 +0100525// Whether to support descriptors (__get__ and __set__)
526// This costs some code size and makes all load attrs and store attrs slow
527#ifndef MICROPY_PY_DESCRIPTORS
528#define MICROPY_PY_DESCRIPTORS (0)
529#endif
530
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300531// Whether str object is proper unicode
532#ifndef MICROPY_PY_BUILTINS_STR_UNICODE
533#define MICROPY_PY_BUILTINS_STR_UNICODE (0)
Damien George8546ce12014-06-28 10:29:22 +0100534#endif
Damien Georgeb3a50f02014-06-28 10:27:15 +0100535
Paul Sokolovskyac2f7a72015-04-04 00:09:23 +0300536// Whether str.splitlines() method provided
537#ifndef MICROPY_PY_BUILTINS_STR_SPLITLINES
538#define MICROPY_PY_BUILTINS_STR_SPLITLINES (0)
539#endif
540
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300541// Whether to support bytearray object
542#ifndef MICROPY_PY_BUILTINS_BYTEARRAY
543#define MICROPY_PY_BUILTINS_BYTEARRAY (1)
Paul Sokolovsky12bc13e2014-06-13 01:05:19 +0300544#endif
545
Damien Georgedd4f4532014-10-23 13:34:35 +0100546// Whether to support memoryview object
547#ifndef MICROPY_PY_BUILTINS_MEMORYVIEW
548#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
549#endif
550
Damien George3ebd4d02014-06-01 13:46:47 +0100551// Whether to support set object
552#ifndef MICROPY_PY_BUILTINS_SET
553#define MICROPY_PY_BUILTINS_SET (1)
554#endif
555
Damien Georgefb510b32014-06-01 13:32:54 +0100556// Whether to support slice subscript operators and slice object
557#ifndef MICROPY_PY_BUILTINS_SLICE
558#define MICROPY_PY_BUILTINS_SLICE (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100559#endif
560
Tom Soulanilleaeb62f92015-09-11 14:31:32 -0700561// Whether to support slice attribute read access,
562// i.e. slice.start, slice.stop, slice.step
563#ifndef MICROPY_PY_BUILTINS_SLICE_ATTRS
564#define MICROPY_PY_BUILTINS_SLICE_ATTRS (0)
565#endif
566
Damien Georgeee3fd462014-05-24 23:03:12 +0100567// Whether to support frozenset object
Damien Georgefb510b32014-06-01 13:32:54 +0100568#ifndef MICROPY_PY_BUILTINS_FROZENSET
569#define MICROPY_PY_BUILTINS_FROZENSET (0)
Damien Georgeee3fd462014-05-24 23:03:12 +0100570#endif
571
Damien Georgefb510b32014-06-01 13:32:54 +0100572// Whether to support property object
573#ifndef MICROPY_PY_BUILTINS_PROPERTY
574#define MICROPY_PY_BUILTINS_PROPERTY (1)
Damien Georgeee3fd462014-05-24 23:03:12 +0100575#endif
576
Peter D. Grayb2a237d2015-03-06 14:48:14 -0500577// Whether to implement the start/stop/step attributes (readback) on
578// the "range" builtin type. Rarely used, and costs ~60 bytes (x86).
579#ifndef MICROPY_PY_BUILTINS_RANGE_ATTRS
580#define MICROPY_PY_BUILTINS_RANGE_ATTRS (1)
581#endif
582
Daniel Campora077812b2015-06-29 22:45:39 +0200583// Whether to support timeout exceptions (like socket.timeout)
584#ifndef MICROPY_PY_BUILTINS_TIMEOUTERROR
585#define MICROPY_PY_BUILTINS_TIMEOUTERROR (0)
586#endif
587
Paul Sokolovsky98c4bc32015-01-30 01:42:49 +0200588// Whether to support complete set of special methods
589// for user classes, otherwise only the most used
590#ifndef MICROPY_PY_ALL_SPECIAL_METHODS
591#define MICROPY_PY_ALL_SPECIAL_METHODS (0)
592#endif
593
Damien Georgec9fc6202014-10-25 21:59:14 +0100594// Whether to support compile function
595#ifndef MICROPY_PY_BUILTINS_COMPILE
596#define MICROPY_PY_BUILTINS_COMPILE (0)
597#endif
598
Paul Sokolovskye2d44e32015-04-06 23:50:37 +0300599// Whether to support enumerate function(type)
600#ifndef MICROPY_PY_BUILTINS_ENUMERATE
601#define MICROPY_PY_BUILTINS_ENUMERATE (1)
602#endif
603
Damien Georgedd5353a2015-12-18 12:35:44 +0000604// Whether to support eval and exec functions
605// By default they are supported if the compiler is enabled
606#ifndef MICROPY_PY_BUILTINS_EVAL_EXEC
607#define MICROPY_PY_BUILTINS_EVAL_EXEC (MICROPY_ENABLE_COMPILER)
608#endif
609
Damien George2a3e2b92014-12-19 13:36:17 +0000610// Whether to support the Python 2 execfile function
611#ifndef MICROPY_PY_BUILTINS_EXECFILE
612#define MICROPY_PY_BUILTINS_EXECFILE (0)
613#endif
614
Paul Sokolovsky22ff3972015-08-20 01:01:56 +0300615// Whether to support filter function(type)
616#ifndef MICROPY_PY_BUILTINS_FILTER
617#define MICROPY_PY_BUILTINS_FILTER (1)
618#endif
619
Paul Sokolovsky282ca092015-04-07 00:16:51 +0300620// Whether to support reversed function(type)
621#ifndef MICROPY_PY_BUILTINS_REVERSED
622#define MICROPY_PY_BUILTINS_REVERSED (1)
623#endif
624
Paul Sokolovsky5ab5ac52015-05-04 19:45:53 +0300625// Whether to define "NotImplemented" special constant
626#ifndef MICROPY_PY_BUILTINS_NOTIMPLEMENTED
627#define MICROPY_PY_BUILTINS_NOTIMPLEMENTED (0)
628#endif
629
pohmelie354e6882015-12-07 15:35:48 +0300630// Whether to support min/max functions
631#ifndef MICROPY_PY_BUILTINS_MIN_MAX
632#define MICROPY_PY_BUILTINS_MIN_MAX (1)
633#endif
634
Paul Sokolovskyd0f5e612014-07-25 11:00:15 +0300635// Whether to set __file__ for imported modules
636#ifndef MICROPY_PY___FILE__
637#define MICROPY_PY___FILE__ (1)
638#endif
639
Damien George89deec02015-01-09 20:12:54 +0000640// Whether to provide mem-info related functions in micropython module
641#ifndef MICROPY_PY_MICROPYTHON_MEM_INFO
642#define MICROPY_PY_MICROPYTHON_MEM_INFO (0)
643#endif
644
Paul Sokolovskycb78f862014-06-27 20:39:09 +0300645// Whether to provide "array" module. Note that large chunk of the
646// underlying code is shared with "bytearray" builtin type, so to
647// get real savings, it should be disabled too.
648#ifndef MICROPY_PY_ARRAY
649#define MICROPY_PY_ARRAY (1)
650#endif
651
Paul Sokolovskycefcbb22015-02-27 22:16:05 +0200652// Whether to support slice assignments for array (and bytearray).
653// This is rarely used, but adds ~0.5K of code.
654#ifndef MICROPY_PY_ARRAY_SLICE_ASSIGN
655#define MICROPY_PY_ARRAY_SLICE_ASSIGN (0)
656#endif
657
Damien George5aa311d2015-04-21 14:14:24 +0000658// Whether to support attrtuple type (MicroPython extension)
659// It provides space-efficient tuples with attribute access
660#ifndef MICROPY_PY_ATTRTUPLE
661#define MICROPY_PY_ATTRTUPLE (1)
662#endif
663
Damien Georgeee3fd462014-05-24 23:03:12 +0100664// Whether to provide "collections" module
665#ifndef MICROPY_PY_COLLECTIONS
666#define MICROPY_PY_COLLECTIONS (1)
667#endif
668
Paul Sokolovsky0ef01d02015-03-18 01:25:04 +0200669// Whether to provide "collections.OrderedDict" type
670#ifndef MICROPY_PY_COLLECTIONS_ORDEREDDICT
671#define MICROPY_PY_COLLECTIONS_ORDEREDDICT (0)
672#endif
673
Damien Georgeee3fd462014-05-24 23:03:12 +0100674// Whether to provide "math" module
675#ifndef MICROPY_PY_MATH
676#define MICROPY_PY_MATH (1)
677#endif
678
Damien George5cbeace2015-02-22 14:48:18 +0000679// Whether to provide special math functions: math.{erf,erfc,gamma,lgamma}
680#ifndef MICROPY_PY_MATH_SPECIAL_FUNCTIONS
681#define MICROPY_PY_MATH_SPECIAL_FUNCTIONS (0)
682#endif
683
Damien Georgeee3fd462014-05-24 23:03:12 +0100684// Whether to provide "cmath" module
685#ifndef MICROPY_PY_CMATH
686#define MICROPY_PY_CMATH (0)
687#endif
688
689// Whether to provide "gc" module
690#ifndef MICROPY_PY_GC
691#define MICROPY_PY_GC (1)
692#endif
693
Paul Sokolovsky755a55f2014-06-05 22:48:02 +0300694// Whether to return number of collected objects from gc.collect()
695#ifndef MICROPY_PY_GC_COLLECT_RETVAL
696#define MICROPY_PY_GC_COLLECT_RETVAL (0)
697#endif
698
Damien Georgeee3fd462014-05-24 23:03:12 +0100699// Whether to provide "io" module
700#ifndef MICROPY_PY_IO
701#define MICROPY_PY_IO (1)
702#endif
703
704// Whether to provide "io.FileIO" class
705#ifndef MICROPY_PY_IO_FILEIO
706#define MICROPY_PY_IO_FILEIO (0)
707#endif
708
709// Whether to provide "io.BytesIO" class
710#ifndef MICROPY_PY_IO_BYTESIO
711#define MICROPY_PY_IO_BYTESIO (1)
712#endif
713
714// Whether to provide "struct" module
715#ifndef MICROPY_PY_STRUCT
716#define MICROPY_PY_STRUCT (1)
717#endif
718
719// Whether to provide "sys" module
720#ifndef MICROPY_PY_SYS
721#define MICROPY_PY_SYS (1)
722#endif
723
Paul Sokolovsky4e0eeeb2014-07-03 16:50:11 +0300724// Whether to provide "sys.maxsize" constant
725#ifndef MICROPY_PY_SYS_MAXSIZE
726#define MICROPY_PY_SYS_MAXSIZE (0)
727#endif
728
Paul Sokolovsky1a1d11f2015-12-05 00:09:10 +0200729// Whether to provide "sys.modules" dictionary
730#ifndef MICROPY_PY_SYS_MODULES
731#define MICROPY_PY_SYS_MODULES (1)
732#endif
733
Paul Sokolovsky8b85d142015-04-25 03:17:41 +0300734// Whether to provide "sys.exc_info" function
735// Avoid enabling this, this function is Python2 heritage
736#ifndef MICROPY_PY_SYS_EXC_INFO
737#define MICROPY_PY_SYS_EXC_INFO (0)
738#endif
739
Damien Georgeee3fd462014-05-24 23:03:12 +0100740// Whether to provide "sys.exit" function
741#ifndef MICROPY_PY_SYS_EXIT
742#define MICROPY_PY_SYS_EXIT (0)
743#endif
744
745// Whether to provide sys.{stdin,stdout,stderr} objects
746#ifndef MICROPY_PY_SYS_STDFILES
747#define MICROPY_PY_SYS_STDFILES (0)
Damien George3bb8bd82014-04-14 21:20:30 +0100748#endif
749
Damien George3c4b5d42015-05-13 23:49:21 +0100750// Whether to provide sys.{stdin,stdout,stderr}.buffer object
751// This is implemented per-port
752#ifndef MICROPY_PY_SYS_STDIO_BUFFER
753#define MICROPY_PY_SYS_STDIO_BUFFER (0)
754#endif
Paul Sokolovsky82158472014-06-28 03:03:47 +0300755
756// Extended modules
Paul Sokolovsky510296f2014-08-08 22:51:40 +0300757
Paul Sokolovsky82158472014-06-28 03:03:47 +0300758#ifndef MICROPY_PY_UCTYPES
759#define MICROPY_PY_UCTYPES (0)
760#endif
761
Paul Sokolovsky34162872014-10-12 08:16:34 -0700762#ifndef MICROPY_PY_UZLIB
763#define MICROPY_PY_UZLIB (0)
764#endif
765
Damien George612045f2014-09-17 22:56:34 +0100766#ifndef MICROPY_PY_UJSON
767#define MICROPY_PY_UJSON (0)
768#endif
769
Paul Sokolovskyc71e0452014-09-12 18:48:07 +0300770#ifndef MICROPY_PY_URE
771#define MICROPY_PY_URE (0)
772#endif
773
Damien Georgef5d69792014-10-22 17:37:18 +0000774#ifndef MICROPY_PY_UHEAPQ
775#define MICROPY_PY_UHEAPQ (0)
776#endif
777
Paul Sokolovskyf4b19c82014-11-22 01:19:13 +0200778#ifndef MICROPY_PY_UHASHLIB
779#define MICROPY_PY_UHASHLIB (0)
780#endif
781
Paul Sokolovskybfdc2052014-11-29 06:19:30 +0200782#ifndef MICROPY_PY_UBINASCII
783#define MICROPY_PY_UBINASCII (0)
784#endif
785
Paul Sokolovsky01162182015-05-03 20:25:40 +0300786#ifndef MICROPY_PY_MACHINE
787#define MICROPY_PY_MACHINE (0)
788#endif
789
Paul Sokolovskyaaa88672015-10-06 18:10:00 +0300790#ifndef MICROPY_PY_USSL
791#define MICROPY_PY_USSL (0)
792#endif
793
Damien George58ebde42014-05-21 20:32:59 +0100794/*****************************************************************************/
795/* Hooks for a port to add builtins */
796
Damien Georgecaac5422014-03-25 14:18:18 +0000797// Additional builtin function definitions - see builtintables.c:builtin_object_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100798#ifndef MICROPY_PORT_BUILTINS
799#define MICROPY_PORT_BUILTINS
Paul Sokolovsky910843e2014-02-14 12:02:34 +0200800#endif
Damien Georgecaac5422014-03-25 14:18:18 +0000801
802// Additional builtin module definitions - see builtintables.c:builtin_module_table for format.
Damien George58ebde42014-05-21 20:32:59 +0100803#ifndef MICROPY_PORT_BUILTIN_MODULES
804#define MICROPY_PORT_BUILTIN_MODULES
Damien Georgecaac5422014-03-25 14:18:18 +0000805#endif
806
Damien Georgec14a8162014-10-12 11:46:04 +0100807// Any module weak links - see builtintables.c:mp_builtin_module_weak_links_table.
808#ifndef MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
809#define MICROPY_PORT_BUILTIN_MODULE_WEAK_LINKS
810#endif
811
Damien George57e99eb2014-04-10 22:42:11 +0100812// Additional constant definitions for the compiler - see compile.c:mp_constants_table.
Damien George58ebde42014-05-21 20:32:59 +0100813#ifndef MICROPY_PORT_CONSTANTS
814#define MICROPY_PORT_CONSTANTS
Damien George57e99eb2014-04-10 22:42:11 +0100815#endif
816
Damien Georgeb4b10fd2015-01-01 23:30:53 +0000817// Any root pointers for GC scanning - see mpstate.c
818#ifndef MICROPY_PORT_ROOT_POINTERS
819#define MICROPY_PORT_ROOT_POINTERS
820#endif
821
Damien George136f6752014-01-07 14:54:15 +0000822/*****************************************************************************/
823/* Miscellaneous settings */
824
Damien George28631532015-02-08 13:42:00 +0000825// All uPy objects in ROM must be aligned on at least a 4 byte boundary
826// so that the small-int/qstr/pointer distinction can be made. For machines
827// that don't do this (eg 16-bit CPU), define the following macro to something
828// like __attribute__((aligned(4))).
829#ifndef MICROPY_OBJ_BASE_ALIGNMENT
830#define MICROPY_OBJ_BASE_ALIGNMENT
831#endif
832
Dave Hylands5b7fd202014-07-01 23:46:53 -0700833// On embedded platforms, these will typically enable/disable irqs.
834#ifndef MICROPY_BEGIN_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000835#define MICROPY_BEGIN_ATOMIC_SECTION() (0)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700836#endif
837#ifndef MICROPY_END_ATOMIC_SECTION
Damien George4859edb2014-10-15 17:33:24 +0000838#define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
Dave Hylands5b7fd202014-07-01 23:46:53 -0700839#endif
840
Paul Sokolovskyd5df6cd2014-02-12 18:15:40 +0200841// Allow to override static modifier for global objects, e.g. to use with
842// object code analysis tools which don't support static symbols.
843#ifndef STATIC
844#define STATIC static
845#endif
846
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200847#define BITS_PER_BYTE (8)
848#define BITS_PER_WORD (BITS_PER_BYTE * BYTES_PER_WORD)
Damien George40f3c022014-07-03 13:25:24 +0100849// mp_int_t value with most significant bit set
850#define WORD_MSBIT_HIGH (((mp_uint_t)1) << (BYTES_PER_WORD * 8 - 1))
Paul Sokolovskyfc5aac82014-01-12 16:10:19 +0200851
Damien Georgea9bcd512014-10-06 13:44:59 +0000852// Make sure both MP_ENDIANNESS_LITTLE and MP_ENDIANNESS_BIG are
853// defined and that they are the opposite of each other.
854#if defined(MP_ENDIANNESS_LITTLE)
855#define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
856#elif defined(MP_ENDIANNESS_BIG)
857#define MP_ENDIANNESS_LITTLE (!MP_ENDIANNESS_BIG)
858#else
859 // Endiannes not defined by port so try to autodetect it.
860 #if defined(__BYTE_ORDER__)
861 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
862 #define MP_ENDIANNESS_LITTLE (1)
863 #else
864 #define MP_ENDIANNESS_LITTLE (0)
865 #endif
Damien Georgef32498f2014-10-06 16:09:31 +0000866 #elif defined(__LITTLE_ENDIAN__) || defined(__LITTLE_ENDIAN) || defined (_LITTLE_ENDIAN)
867 #define MP_ENDIANNESS_LITTLE (1)
Damien Georgea9bcd512014-10-06 13:44:59 +0000868 #elif defined(__BIG_ENDIAN__) || defined(__BIG_ENDIAN) || defined (_BIG_ENDIAN)
869 #define MP_ENDIANNESS_LITTLE (0)
870 #else
Damien George4e4772b2015-05-30 23:12:30 +0100871 #include <endian.h>
872 #if defined(__BYTE_ORDER)
873 #if __BYTE_ORDER == __LITTLE_ENDIAN
874 #define MP_ENDIANNESS_LITTLE (1)
875 #else
876 #define MP_ENDIANNESS_LITTLE (0)
877 #endif
878 #else
879 #error endianness not defined and cannot detect it
880 #endif
Damien Georgea9bcd512014-10-06 13:44:59 +0000881 #endif
882 #define MP_ENDIANNESS_BIG (!MP_ENDIANNESS_LITTLE)
Andrew Schellercc837372014-04-14 02:39:56 +0100883#endif
Paul Sokolovsky2da81fa2014-04-11 03:44:00 +0300884
Damien George3c658a42014-08-24 16:28:17 +0100885// Make a pointer to RAM callable (eg set lower bit for Thumb code)
886// (This scheme won't work if we want to mix Thumb and normal ARM code.)
887#ifndef MICROPY_MAKE_POINTER_CALLABLE
888#define MICROPY_MAKE_POINTER_CALLABLE(p) (p)
889#endif
890
Damien George7f9d1d62015-04-09 23:56:15 +0100891// If these MP_PLAT_*_EXEC macros are overridden then the memory allocated by them
Damien George2127e9a2015-01-14 00:11:09 +0000892// must be somehow reachable for marking by the GC, since the native code
893// generators store pointers to GC managed memory in the code.
Fabian Vogtb7235b82014-09-03 16:59:33 +0200894#ifndef MP_PLAT_ALLOC_EXEC
Damien George4dea9222015-04-09 15:29:54 +0000895#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 +0200896#endif
897
898#ifndef MP_PLAT_FREE_EXEC
899#define MP_PLAT_FREE_EXEC(ptr, size) m_del(byte, ptr, size)
900#endif
901
Damien George7f9d1d62015-04-09 23:56:15 +0100902// This macro is used to do all output (except when MICROPY_PY_IO is defined)
903#ifndef MP_PLAT_PRINT_STRN
Damien George4300c7d2015-10-15 00:05:55 +0100904#define MP_PLAT_PRINT_STRN(str, len) mp_hal_stdout_tx_strn_cooked(str, len)
Damien George7f9d1d62015-04-09 23:56:15 +0100905#endif
906
Paul Sokolovsky722e5622014-09-06 19:17:23 +0300907#ifndef MP_SSIZE_MAX
908#define MP_SSIZE_MAX SSIZE_MAX
909#endif
910
Damien George40f3c022014-07-03 13:25:24 +0100911// printf format spec to use for mp_int_t and friends
Damien George136f6752014-01-07 14:54:15 +0000912#ifndef INT_FMT
stijn3baf6b52015-11-20 15:59:06 +0100913#if defined(__LP64__)
Damien George40f3c022014-07-03 13:25:24 +0100914// Archs where mp_int_t == long, long != int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200915#define UINT_FMT "%lu"
916#define INT_FMT "%ld"
stijn3baf6b52015-11-20 15:59:06 +0100917#elif defined(_WIN64)
stijn0a4eb4d2015-12-18 10:20:33 +0100918#define UINT_FMT "%llu"
919#define INT_FMT "%lld"
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200920#else
Damien George40f3c022014-07-03 13:25:24 +0100921// Archs where mp_int_t == int
Paul Sokolovskyc90c0f62014-01-04 01:57:00 +0200922#define UINT_FMT "%u"
923#define INT_FMT "%d"
924#endif
925#endif //INT_FMT
Paul Sokolovskye9085912014-04-30 05:35:18 +0300926
927// Modifier for function which doesn't return
stijn01d6be42014-05-05 12:18:27 +0200928#ifndef NORETURN
Paul Sokolovskye9085912014-04-30 05:35:18 +0300929#define NORETURN __attribute__((noreturn))
stijn01d6be42014-05-05 12:18:27 +0200930#endif
mux5c8db482014-06-21 17:24:55 +0200931
932// Modifier for weak functions
933#ifndef MP_WEAK
934#define MP_WEAK __attribute__((weak))
935#endif
Paul Sokolovsky361909e2014-12-29 00:51:06 +0200936
937// Condition is likely to be true, to help branch prediction
938#ifndef MP_LIKELY
939#define MP_LIKELY(x) __builtin_expect((x), 1)
940#endif
941
942// Condition is likely to be false, to help branch prediction
943#ifndef MP_UNLIKELY
944#define MP_UNLIKELY(x) __builtin_expect((x), 0)
945#endif
Damien George9ddbe292014-12-29 01:02:19 +0000946
947#endif // __MICROPY_INCLUDED_PY_MPCONFIG_H__