malloc.c 5.71 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
#include "mpconfig.h"
32
#include "misc.h"
Damien's avatar
Damien committed
33

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

40
#if MICROPY_MEM_STATS
41
42
43
STATIC int total_bytes_allocated = 0;
STATIC int current_bytes_allocated = 0;
STATIC int peak_bytes_allocated = 0;
44
45

#define UPDATE_PEAK() { if (current_bytes_allocated > peak_bytes_allocated) peak_bytes_allocated = current_bytes_allocated; }
46
#endif
Damien's avatar
Damien committed
47

48
49
50
51
52
53
54
55
56
57
58
#if MICROPY_ENABLE_GC
#include "gc.h"

// 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
59
60
#define malloc(b) gc_alloc((b), false)
#define malloc_with_finaliser(b) gc_alloc((b), true)
61
62
63
64
#define free gc_free
#define realloc gc_realloc
#endif // MICROPY_ENABLE_GC

Damien's avatar
Damien committed
65
66
67
68
69
70
void *m_malloc(int num_bytes) {
    if (num_bytes == 0) {
        return NULL;
    }
    void *ptr = malloc(num_bytes);
    if (ptr == NULL) {
71
        return m_malloc_fail(num_bytes);
Damien's avatar
Damien committed
72
    }
73
#if MICROPY_MEM_STATS
Damien's avatar
Damien committed
74
    total_bytes_allocated += num_bytes;
75
    current_bytes_allocated += num_bytes;
76
    UPDATE_PEAK();
77
#endif
78
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
Damien's avatar
Damien committed
79
    return ptr;
80
81
82
83
84
85
86
87
88
89
90
91
92
93
}

void *m_malloc_maybe(int num_bytes) {
    void *ptr = malloc(num_bytes);
    if (ptr == NULL) {
        return NULL;
    }
#if MICROPY_MEM_STATS
    total_bytes_allocated += num_bytes;
    current_bytes_allocated += num_bytes;
    UPDATE_PEAK();
#endif
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
    return ptr;
Damien's avatar
Damien committed
94
95
}

96
97
#if MICROPY_ENABLE_FINALISER
void *m_malloc_with_finaliser(int num_bytes) {
mux's avatar
mux committed
98
99
100
    if (num_bytes == 0) {
        return NULL;
    }
101
    void *ptr = malloc_with_finaliser(num_bytes);
mux's avatar
mux committed
102
    if (ptr == NULL) {
103
        return m_malloc_fail(num_bytes);
mux's avatar
mux committed
104
105
106
107
108
109
110
111
112
    }
#if MICROPY_MEM_STATS
    total_bytes_allocated += num_bytes;
    current_bytes_allocated += num_bytes;
    UPDATE_PEAK();
#endif
    DEBUG_printf("malloc %d : %p\n", num_bytes, ptr);
    return ptr;
}
113
#endif
mux's avatar
mux committed
114

Damien's avatar
Damien committed
115
void *m_malloc0(int num_bytes) {
Paul Sokolovsky's avatar
Paul Sokolovsky committed
116
117
118
    void *ptr = m_malloc(num_bytes);
    if (ptr != NULL) {
        memset(ptr, 0, num_bytes);
Damien's avatar
Damien committed
119
120
121
122
    }
    return ptr;
}

123
124
void *m_realloc(void *ptr, int old_num_bytes, int new_num_bytes) {
    if (new_num_bytes == 0) {
Damien's avatar
Damien committed
125
126
127
        free(ptr);
        return NULL;
    }
128
129
    void *new_ptr = realloc(ptr, new_num_bytes);
    if (new_ptr == NULL) {
130
        return m_malloc_fail(new_num_bytes);
Damien's avatar
Damien committed
131
    }
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#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.
    int diff = new_num_bytes - old_num_bytes;
    total_bytes_allocated += diff;
    current_bytes_allocated += diff;
    UPDATE_PEAK();
#endif
    DEBUG_printf("realloc %p, %d, %d : %p\n", ptr, old_num_bytes, new_num_bytes, new_ptr);
    return new_ptr;
}

void *m_realloc_maybe(void *ptr, int old_num_bytes, int new_num_bytes) {
    void *new_ptr = realloc(ptr, new_num_bytes);
    if (new_ptr == NULL) {
        return NULL;
    }
152
#if MICROPY_MEM_STATS
153
154
155
156
157
    // 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.
158
159
160
    int diff = new_num_bytes - old_num_bytes;
    total_bytes_allocated += diff;
    current_bytes_allocated += diff;
161
    UPDATE_PEAK();
162
#endif
163
164
    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
165
166
}

167
168
169
170
void m_free(void *ptr, int num_bytes) {
    if (ptr != NULL) {
        free(ptr);
    }
171
#if MICROPY_MEM_STATS
172
    current_bytes_allocated -= num_bytes;
173
#endif
174
    DEBUG_printf("free %p, %d\n", ptr, num_bytes);
175
176
}

177
int m_get_total_bytes_allocated(void) {
178
#if MICROPY_MEM_STATS
Damien's avatar
Damien committed
179
    return total_bytes_allocated;
180
181
182
#else
    return -1;
#endif
Damien's avatar
Damien committed
183
}
184
185

int m_get_current_bytes_allocated(void) {
186
#if MICROPY_MEM_STATS
187
    return current_bytes_allocated;
188
189
190
#else
    return -1;
#endif
191
}
192
193

int m_get_peak_bytes_allocated(void) {
194
#if MICROPY_MEM_STATS
195
    return peak_bytes_allocated;
196
197
198
#else
    return -1;
#endif
199
}