1/*
2 * This file is part of the MicroPython 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 */
26#ifndef MICROPY_INCLUDED_PY_MISC_H
27#define MICROPY_INCLUDED_PY_MISC_H
28
29// a mini library of useful types and functions
30
31/** types *******************************************************/
32
33#include <stdbool.h>
34#include <stdint.h>
35#include <stddef.h>
36
37typedef unsigned char byte;
38typedef unsigned int uint;
39
40/** generic ops *************************************************/
41
42#ifndef MIN
43#define MIN(x, y) ((x) < (y) ? (x) : (y))
44#endif
45#ifndef MAX
46#define MAX(x, y) ((x) > (y) ? (x) : (y))
47#endif
48
49// Classical double-indirection stringification of preprocessor macro's value
50#define MP_STRINGIFY_HELPER(x) #x
51#define MP_STRINGIFY(x) MP_STRINGIFY_HELPER(x)
52
53// Static assertion macro
54#define MP_STATIC_ASSERT(cond) ((void)sizeof(char[1 - 2 * !(cond)]))
55
56// Round-up integer division
57#define MP_CEIL_DIVIDE(a, b) (((a) + (b) - 1) / (b))
58
59/** memory allocation ******************************************/
60
61// TODO make a lazy m_renew that can increase by a smaller amount than requested (but by at least 1 more element)
62
63#define m_new(type, num) ((type *)(m_malloc(sizeof(type) * (num))))
64#define m_new_maybe(type, num) ((type *)(m_malloc_maybe(sizeof(type) * (num))))
65#define m_new0(type, num) ((type *)(m_malloc0(sizeof(type) * (num))))
66#define m_new_obj(type) (m_new(type, 1))
67#define m_new_obj_maybe(type) (m_new_maybe(type, 1))
68#define m_new_obj_var(obj_type, var_type, var_num) ((obj_type *)m_malloc(sizeof(obj_type) + sizeof(var_type) * (var_num)))
69#define m_new_obj_var_maybe(obj_type, var_type, var_num) ((obj_type *)m_malloc_maybe(sizeof(obj_type) + sizeof(var_type) * (var_num)))
70#if MICROPY_ENABLE_FINALISER
71#define m_new_obj_with_finaliser(type) ((type *)(m_malloc_with_finaliser(sizeof(type))))
72#define m_new_obj_var_with_finaliser(type, var_type, var_num) ((type *)m_malloc_with_finaliser(sizeof(type) + sizeof(var_type) * (var_num)))
73#else
74#define m_new_obj_with_finaliser(type) m_new_obj(type)
75#define m_new_obj_var_with_finaliser(type, var_type, var_num) m_new_obj_var(type, var_type, var_num)
76#endif
77#if MICROPY_MALLOC_USES_ALLOCATED_SIZE
78#define m_renew(type, ptr, old_num, new_num) ((type *)(m_realloc((ptr), sizeof(type) * (old_num), sizeof(type) * (new_num))))
79#define m_renew_maybe(type, ptr, old_num, new_num, allow_move) ((type *)(m_realloc_maybe((ptr), sizeof(type) * (old_num), sizeof(type) * (new_num), (allow_move))))
80#define m_del(type, ptr, num) m_free(ptr, sizeof(type) * (num))
81#define m_del_var(obj_type, var_type, var_num, ptr) (m_free(ptr, sizeof(obj_type) + sizeof(var_type) * (var_num)))
82#else
83#define m_renew(type, ptr, old_num, new_num) ((type *)(m_realloc((ptr), sizeof(type) * (new_num))))
84#define m_renew_maybe(type, ptr, old_num, new_num, allow_move) ((type *)(m_realloc_maybe((ptr), sizeof(type) * (new_num), (allow_move))))
85#define m_del(type, ptr, num) ((void)(num), m_free(ptr))
86#define m_del_var(obj_type, var_type, var_num, ptr) ((void)(var_num), m_free(ptr))
87#endif
88#define m_del_obj(type, ptr) (m_del(type, ptr, 1))
89
90void *m_malloc(size_t num_bytes);
91void *m_malloc_maybe(size_t num_bytes);
92void *m_malloc_with_finaliser(size_t num_bytes);
93void *m_malloc0(size_t num_bytes);
94#if MICROPY_MALLOC_USES_ALLOCATED_SIZE
95void *m_realloc(void *ptr, size_t old_num_bytes, size_t new_num_bytes);
96void *m_realloc_maybe(void *ptr, size_t old_num_bytes, size_t new_num_bytes, bool allow_move);
97void m_free(void *ptr, size_t num_bytes);
98#else
99void *m_realloc(void *ptr, size_t new_num_bytes);
100void *m_realloc_maybe(void *ptr, size_t new_num_bytes, bool allow_move);
101void m_free(void *ptr);
102#endif
103NORETURN void m_malloc_fail(size_t num_bytes);
104
105#if MICROPY_MEM_STATS
106size_t m_get_total_bytes_allocated(void);
107size_t m_get_current_bytes_allocated(void);
108size_t m_get_peak_bytes_allocated(void);
109#endif
110
111/** array helpers ***********************************************/
112
113// get the number of elements in a fixed-size array
114#define MP_ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
115
116// align ptr to the nearest multiple of "alignment"
117#define MP_ALIGN(ptr, alignment) (void *)(((uintptr_t)(ptr) + ((alignment) - 1)) & ~((alignment) - 1))
118
119/** unichar / UTF-8 *********************************************/
120
121#if MICROPY_PY_BUILTINS_STR_UNICODE
122// with unicode enabled we need a type which can fit chars up to 0x10ffff
123typedef uint32_t unichar;
124#else
125// without unicode enabled we can only need to fit chars up to 0xff
126// (on 16-bit archs uint is 16-bits and more efficient than uint32_t)
127typedef uint unichar;
128#endif
129
130#if MICROPY_PY_BUILTINS_STR_UNICODE
131unichar utf8_get_char(const byte *s);
132const byte *utf8_next_char(const byte *s);
133size_t utf8_charlen(const byte *str, size_t len);
134#else
135static inline unichar utf8_get_char(const byte *s) {
136 return *s;
137}
138static inline const byte *utf8_next_char(const byte *s) {
139 return s + 1;
140}
141static inline size_t utf8_charlen(const byte *str, size_t len) {
142 (void)str;
143 return len;
144}
145#endif
146
147bool unichar_isspace(unichar c);
148bool unichar_isalpha(unichar c);
149bool unichar_isprint(unichar c);
150bool unichar_isdigit(unichar c);
151bool unichar_isxdigit(unichar c);
152bool unichar_isident(unichar c);
153bool unichar_isalnum(unichar c);
154bool unichar_isupper(unichar c);
155bool unichar_islower(unichar c);
156unichar unichar_tolower(unichar c);
157unichar unichar_toupper(unichar c);
158mp_uint_t unichar_xdigit_value(unichar c);
159#define UTF8_IS_NONASCII(ch) ((ch) & 0x80)
160#define UTF8_IS_CONT(ch) (((ch) & 0xC0) == 0x80)
161
162/** variable string *********************************************/
163
164typedef struct _vstr_t {
165 size_t alloc;
166 size_t len;
167 char *buf;
168 bool fixed_buf : 1;
169} vstr_t;
170
171// convenience macro to declare a vstr with a fixed size buffer on the stack
172#define VSTR_FIXED(vstr, alloc) vstr_t vstr; char vstr##_buf[(alloc)]; vstr_init_fixed_buf(&vstr, (alloc), vstr##_buf);
173
174void vstr_init(vstr_t *vstr, size_t alloc);
175void vstr_init_len(vstr_t *vstr, size_t len);
176void vstr_init_fixed_buf(vstr_t *vstr, size_t alloc, char *buf);
177struct _mp_print_t;
178void vstr_init_print(vstr_t *vstr, size_t alloc, struct _mp_print_t *print);
179void vstr_clear(vstr_t *vstr);
180vstr_t *vstr_new(size_t alloc);
181void vstr_free(vstr_t *vstr);
182static inline void vstr_reset(vstr_t *vstr) {
183 vstr->len = 0;
184}
185static inline char *vstr_str(vstr_t *vstr) {
186 return vstr->buf;
187}
188static inline size_t vstr_len(vstr_t *vstr) {
189 return vstr->len;
190}
191void vstr_hint_size(vstr_t *vstr, size_t size);
192char *vstr_extend(vstr_t *vstr, size_t size);
193char *vstr_add_len(vstr_t *vstr, size_t len);
194char *vstr_null_terminated_str(vstr_t *vstr);
195void vstr_add_byte(vstr_t *vstr, byte v);
196void vstr_add_char(vstr_t *vstr, unichar chr);
197void vstr_add_str(vstr_t *vstr, const char *str);
198void vstr_add_strn(vstr_t *vstr, const char *str, size_t len);
199void vstr_ins_byte(vstr_t *vstr, size_t byte_pos, byte b);
200void vstr_ins_char(vstr_t *vstr, size_t char_pos, unichar chr);
201void vstr_cut_head_bytes(vstr_t *vstr, size_t bytes_to_cut);
202void vstr_cut_tail_bytes(vstr_t *vstr, size_t bytes_to_cut);
203void vstr_cut_out_bytes(vstr_t *vstr, size_t byte_pos, size_t bytes_to_cut);
204void vstr_printf(vstr_t *vstr, const char *fmt, ...);
205
206/** non-dynamic size-bounded variable buffer/string *************/
207
208#define CHECKBUF(buf, max_size) char buf[max_size + 1]; size_t buf##_len = max_size; char *buf##_p = buf;
209#define CHECKBUF_RESET(buf, max_size) buf##_len = max_size; buf##_p = buf;
210#define CHECKBUF_APPEND(buf, src, src_len) \
211 { size_t l = MIN(src_len, buf##_len); \
212 memcpy(buf##_p, src, l); \
213 buf##_len -= l; \
214 buf##_p += l; }
215#define CHECKBUF_APPEND_0(buf) { *buf##_p = 0; }
216#define CHECKBUF_LEN(buf) (buf##_p - buf)
217
218#ifdef va_start
219void vstr_vprintf(vstr_t *vstr, const char *fmt, va_list ap);
220#endif
221
222// Debugging helpers
223int DEBUG_printf(const char *fmt, ...);
224
225extern mp_uint_t mp_verbose_flag;
226
227/** float internals *************/
228
229#if MICROPY_PY_BUILTINS_FLOAT
230
231#if MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_DOUBLE
232#define MP_FLOAT_EXP_BITS (11)
233#define MP_FLOAT_FRAC_BITS (52)
234typedef uint64_t mp_float_uint_t;
235#elif MICROPY_FLOAT_IMPL == MICROPY_FLOAT_IMPL_FLOAT
236#define MP_FLOAT_EXP_BITS (8)
237#define MP_FLOAT_FRAC_BITS (23)
238typedef uint32_t mp_float_uint_t;
239#endif
240
241#define MP_FLOAT_EXP_BIAS ((1 << (MP_FLOAT_EXP_BITS - 1)) - 1)
242
243typedef union _mp_float_union_t {
244 mp_float_t f;
245 #if MP_ENDIANNESS_LITTLE
246 struct {
247 mp_float_uint_t frc : MP_FLOAT_FRAC_BITS;
248 mp_float_uint_t exp : MP_FLOAT_EXP_BITS;
249 mp_float_uint_t sgn : 1;
250 } p;
251 #else
252 struct {
253 mp_float_uint_t sgn : 1;
254 mp_float_uint_t exp : MP_FLOAT_EXP_BITS;
255 mp_float_uint_t frc : MP_FLOAT_FRAC_BITS;
256 } p;
257 #endif
258 mp_float_uint_t i;
259} mp_float_union_t;
260
261#endif // MICROPY_PY_BUILTINS_FLOAT
262
263/** ROM string compression *************/
264
265#if MICROPY_ROM_TEXT_COMPRESSION
266
267#ifdef NO_QSTR
268
269// Compression enabled but doing QSTR extraction.
270// So leave MP_COMPRESSED_ROM_TEXT in place for makeqstrdefs.py / makecompresseddata.py to find them.
271
272#else
273
274// Compression enabled and doing a regular build.
275// Map MP_COMPRESSED_ROM_TEXT to the compressed strings.
276
277// Force usage of the MP_ERROR_TEXT macro by requiring an opaque type.
278typedef struct {
279 #ifdef __clang__
280 // Fix "error: empty struct has size 0 in C, size 1 in C++".
281 char dummy;
282 #endif
283} *mp_rom_error_text_t;
284
285#include <string.h>
286
287inline __attribute__((always_inline)) const char *MP_COMPRESSED_ROM_TEXT(const char *msg) {
288 // "genhdr/compressed.data.h" contains an invocation of the MP_MATCH_COMPRESSED macro for each compressed string.
289 // The giant if(strcmp) tree is optimized by the compiler, which turns this into a direct return of the compressed data.
290 #define MP_MATCH_COMPRESSED(a, b) if (strcmp(msg, a) == 0) { return b; } else
291
292 // It also contains a single invocation of the MP_COMPRESSED_DATA macro, we don't need that here.
293 #define MP_COMPRESSED_DATA(x)
294
295 #include "genhdr/compressed.data.h"
296
297#undef MP_COMPRESSED_DATA
298#undef MP_MATCH_COMPRESSED
299
300 return msg;
301}
302
303#endif
304
305#else
306
307// Compression not enabled, just make it a no-op.
308
309typedef const char *mp_rom_error_text_t;
310#define MP_COMPRESSED_ROM_TEXT(x) x
311
312#endif // MICROPY_ROM_TEXT_COMPRESSION
313
314// Might add more types of compressed text in the future.
315// For now, forward directly to MP_COMPRESSED_ROM_TEXT.
316#define MP_ERROR_TEXT(x) (mp_rom_error_text_t)MP_COMPRESSED_ROM_TEXT(x)
317
318#endif // MICROPY_INCLUDED_PY_MISC_H
319