malloc.c 6 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

Damien's avatar
Damien committed
27
28
#include <stdio.h>
#include <stdlib.h>
Paul Sokolovsky's avatar
Paul Sokolovsky committed
29
#include <string.h>
Damien's avatar
Damien committed
30

31
32
#include "py/mpconfig.h"
#include "py/misc.h"
33
#include "py/mpstate.h"
Damien's avatar
Damien committed
34

35
#if 0 // print debugging info
36
#define DEBUG_printf DEBUG_printf
37
#else // don't print debugging info
38
#define DEBUG_printf(...) (void)0
39
40
#endif

41
#if MICROPY_MEM_STATS
42
#define UPDATE_PEAK() { if (MP_STATE_MEM(current_bytes_allocated) > MP_STATE_MEM(peak_bytes_allocated)) MP_STATE_MEM(peak_bytes_allocated) = MP_STATE_MEM(current_bytes_allocated); }
43
#endif
Damien's avatar
Damien committed
44

45
#if MICROPY_ENABLE_GC
46
#include "py/gc.h"
47
48
49
50
51
52
53
54
55

// We redirect standard alloc functions to GC heap - just for the rest of
// this module. In the rest of micropython source, system malloc can be
// freely accessed - for interfacing with system and 3rd-party libs for
// example. On the other hand, some (e.g. bare-metal) ports may use GC
// heap as system heap, so, to avoid warnings, we do undef's first.
#undef malloc
#undef free
#undef realloc
56
57
#define malloc(b) gc_alloc((b), false)
#define malloc_with_finaliser(b) gc_alloc((b), true)
58
59
60
61
#define free gc_free
#define realloc gc_realloc
#endif // MICROPY_ENABLE_GC

62
void *m_malloc(size_t num_bytes) {
Damien's avatar
Damien committed
63
    void *ptr = malloc(num_bytes);
64
    if (ptr == NULL && num_bytes != 0) {
65
        return m_malloc_fail(num_bytes);
Damien's avatar
Damien committed
66
    }
67
#if MICROPY_MEM_STATS
68
69
    MP_STATE_MEM(total_bytes_allocated) += num_bytes;
    MP_STATE_MEM(current_bytes_allocated) += num_bytes;
70
    UPDATE_PEAK();
71
#endif
72
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
Damien's avatar
Damien committed
73
    return ptr;
74
75
}

76
void *m_malloc_maybe(size_t num_bytes) {
77
78
    void *ptr = malloc(num_bytes);
#if MICROPY_MEM_STATS
79
80
    MP_STATE_MEM(total_bytes_allocated) += num_bytes;
    MP_STATE_MEM(current_bytes_allocated) += num_bytes;
81
82
83
84
    UPDATE_PEAK();
#endif
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
    return ptr;
Damien's avatar
Damien committed
85
86
}

87
#if MICROPY_ENABLE_FINALISER
88
void *m_malloc_with_finaliser(size_t num_bytes) {
89
    void *ptr = malloc_with_finaliser(num_bytes);
90
    if (ptr == NULL && num_bytes != 0) {
91
        return m_malloc_fail(num_bytes);
mux's avatar
mux committed
92
93
    }
#if MICROPY_MEM_STATS
94
95
    MP_STATE_MEM(total_bytes_allocated) += num_bytes;
    MP_STATE_MEM(current_bytes_allocated) += num_bytes;
mux's avatar
mux committed
96
97
98
99
100
    UPDATE_PEAK();
#endif
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
    return ptr;
}
101
#endif
mux's avatar
mux committed
102

103
void *m_malloc0(size_t num_bytes) {
Paul Sokolovsky's avatar
Paul Sokolovsky committed
104
    void *ptr = m_malloc(num_bytes);
105
106
    if (ptr == NULL && num_bytes != 0) {
        return m_malloc_fail(num_bytes);
Damien's avatar
Damien committed
107
    }
108
    memset(ptr, 0, num_bytes);
Damien's avatar
Damien committed
109
110
111
    return ptr;
}

112
#if MICROPY_MALLOC_USES_ALLOCATED_SIZE
113
void *m_realloc(void *ptr, size_t old_num_bytes, size_t new_num_bytes) {
114
115
116
#else
void *m_realloc(void *ptr, size_t new_num_bytes) {
#endif
117
    void *new_ptr = realloc(ptr, new_num_bytes);
118
    if (new_ptr == NULL && new_num_bytes != 0) {
119
        return m_malloc_fail(new_num_bytes);
Damien's avatar
Damien committed
120
    }
121
122
123
124
125
126
#if MICROPY_MEM_STATS
    // At first thought, "Total bytes allocated" should only grow,
    // after all, it's *total*. But consider for example 2K block
    // shrunk to 1K and then grown to 2K again. It's still 2K
    // allocated total. If we process only positive increments,
    // we'll count 3K.
127
    size_t diff = new_num_bytes - old_num_bytes;
128
129
    MP_STATE_MEM(total_bytes_allocated) += diff;
    MP_STATE_MEM(current_bytes_allocated) += diff;
130
131
132
133
134
135
    UPDATE_PEAK();
#endif
    DEBUG_printf("realloc %p, %d, %d : %p\n", ptr, old_num_bytes, new_num_bytes, new_ptr);
    return new_ptr;
}

136
#if MICROPY_MALLOC_USES_ALLOCATED_SIZE
137
void *m_realloc_maybe(void *ptr, size_t old_num_bytes, size_t new_num_bytes) {
138
139
140
#else
void *m_realloc_maybe(void *ptr, size_t new_num_bytes) {
#endif
141
    void *new_ptr = realloc(ptr, new_num_bytes);
142
#if MICROPY_MEM_STATS
143
144
145
146
147
    // At first thought, "Total bytes allocated" should only grow,
    // after all, it's *total*. But consider for example 2K block
    // shrunk to 1K and then grown to 2K again. It's still 2K
    // allocated total. If we process only positive increments,
    // we'll count 3K.
148
149
150
    // Also, don't count failed reallocs.
    if (!(new_ptr == NULL && new_num_bytes != 0)) {
        size_t diff = new_num_bytes - old_num_bytes;
151
152
        MP_STATE_MEM(total_bytes_allocated) += diff;
        MP_STATE_MEM(current_bytes_allocated) += diff;
153
154
        UPDATE_PEAK();
    }
155
#endif
156
157
    DEBUG_printf("realloc %p, %d, %d : %p\n", ptr, old_num_bytes, new_num_bytes, new_ptr);
    return new_ptr;
Damien's avatar
Damien committed
158
159
}

160
#if MICROPY_MALLOC_USES_ALLOCATED_SIZE
161
void m_free(void *ptr, size_t num_bytes) {
162
163
164
#else
void m_free(void *ptr) {
#endif
165
    free(ptr);
166
#if MICROPY_MEM_STATS
167
    MP_STATE_MEM(current_bytes_allocated) -= num_bytes;
168
#endif
169
    DEBUG_printf("free %p, %d\n", ptr, num_bytes);
170
171
}

172
#if MICROPY_MEM_STATS
173
size_t m_get_total_bytes_allocated(void) {
174
    return MP_STATE_MEM(total_bytes_allocated);
Damien's avatar
Damien committed
175
}
176

177
size_t m_get_current_bytes_allocated(void) {
178
    return MP_STATE_MEM(current_bytes_allocated);
179
}
180

181
size_t m_get_peak_bytes_allocated(void) {
182
    return MP_STATE_MEM(peak_bytes_allocated);
183
}
184
#endif