malloc.c 5.57 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"
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 size_t total_bytes_allocated = 0;
STATIC size_t current_bytes_allocated = 0;
STATIC size_t 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
#if MICROPY_ENABLE_GC
49
#include "py/gc.h"
50
51
52
53
54
55
56
57
58

// 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

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

79
void *m_malloc_maybe(size_t num_bytes) {
80
81
82
83
84
85
86
87
    void *ptr = malloc(num_bytes);
#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
88
89
}

90
#if MICROPY_ENABLE_FINALISER
91
void *m_malloc_with_finaliser(size_t num_bytes) {
92
    void *ptr = malloc_with_finaliser(num_bytes);
93
    if (ptr == NULL && num_bytes != 0) {
94
        return m_malloc_fail(num_bytes);
mux's avatar
mux committed
95
96
97
98
99
100
101
102
103
    }
#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;
}
104
#endif
mux's avatar
mux committed
105

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

115
void *m_realloc(void *ptr, size_t old_num_bytes, size_t new_num_bytes) {
116
    void *new_ptr = realloc(ptr, new_num_bytes);
117
    if (new_ptr == NULL && new_num_bytes != 0) {
118
        return m_malloc_fail(new_num_bytes);
Damien's avatar
Damien committed
119
    }
120
121
122
123
124
125
#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.
126
    size_t diff = new_num_bytes - old_num_bytes;
127
128
129
130
131
132
133
134
    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;
}

135
void *m_realloc_maybe(void *ptr, size_t old_num_bytes, size_t new_num_bytes) {
136
    void *new_ptr = realloc(ptr, new_num_bytes);
137
#if MICROPY_MEM_STATS
138
139
140
141
142
    // 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.
143
144
145
146
147
148
149
    // Also, don't count failed reallocs.
    if (!(new_ptr == NULL && new_num_bytes != 0)) {
        size_t diff = new_num_bytes - old_num_bytes;
        total_bytes_allocated += diff;
        current_bytes_allocated += diff;
        UPDATE_PEAK();
    }
150
#endif
151
152
    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
153
154
}

155
void m_free(void *ptr, size_t num_bytes) {
156
    free(ptr);
157
#if MICROPY_MEM_STATS
158
    current_bytes_allocated -= num_bytes;
159
#endif
160
    DEBUG_printf("free %p, %d\n", ptr, num_bytes);
161
162
}

163
#if MICROPY_MEM_STATS
164
size_t m_get_total_bytes_allocated(void) {
Damien's avatar
Damien committed
165
166
    return total_bytes_allocated;
}
167

168
size_t m_get_current_bytes_allocated(void) {
169
170
    return current_bytes_allocated;
}
171

172
size_t m_get_peak_bytes_allocated(void) {
173
174
    return peak_bytes_allocated;
}
175
#endif