Gordon Craig / mbed-dev

Forked.

Fork of mbed-dev by mbed official

platform/mbed_alloc_wrappers.cpp@167:e84263d55307, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:46:44 2017 +0100
Revision:
167:e84263d55307
Parent:
160:d5399cc887bb 
This updates the lib to the mbed lib v 145

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1 /* mbed Microcontroller Library
<> 149:156823d33999 2 * Copyright (c) 2006-2016 ARM Limited
<> 149:156823d33999 3 *
<> 149:156823d33999 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 149:156823d33999 5 * you may not use this file except in compliance with the License.
<> 149:156823d33999 6 * You may obtain a copy of the License at
<> 149:156823d33999 7 *
<> 149:156823d33999 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 149:156823d33999 9 *
<> 149:156823d33999 10 * Unless required by applicable law or agreed to in writing, software
<> 149:156823d33999 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 149:156823d33999 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 149:156823d33999 13 * See the License for the specific language governing permissions and
<> 149:156823d33999 14 * limitations under the License.
<> 149:156823d33999 15 */
<> 149:156823d33999 16
<> 149:156823d33999 17 #include "platform/mbed_mem_trace.h"
<> 149:156823d33999 18 #include "platform/mbed_stats.h"
<> 160:d5399cc887bb 19 #include "platform/mbed_toolchain.h"
<> 149:156823d33999 20 #include "platform/SingletonPtr.h"
<> 149:156823d33999 21 #include "platform/PlatformMutex.h"
<> 149:156823d33999 22 #include <stddef.h>
<> 149:156823d33999 23 #include <stdio.h>
<> 149:156823d33999 24 #include <string.h>
<> 149:156823d33999 25 #include <stdlib.h>
<> 149:156823d33999 26
<> 149:156823d33999 27 /* There are two memory tracers in mbed OS:
<> 149:156823d33999 28
<> 149:156823d33999 29 - the first can be used to detect the maximum heap usage at runtime. It is
<> 149:156823d33999 30 activated by defining the MBED_HEAP_STATS_ENABLED macro.
<> 149:156823d33999 31 - the second can be used to trace each memory call by automatically invoking
<> 149:156823d33999 32 a callback on each memory operation (see hal/api/mbed_mem_trace.h). It is
<> 149:156823d33999 33 activated by defining the MBED_MEM_TRACING_ENABLED macro.
<> 149:156823d33999 34
<> 149:156823d33999 35 Both tracers can be activated and deactivated in any combination. If both tracers
<> 149:156823d33999 36 are active, the second one (MBED_MEM_TRACING_ENABLED) will trace the first one's
<> 149:156823d33999 37 (MBED_HEAP_STATS_ENABLED) memory calls.*/
<> 149:156823d33999 38
<> 149:156823d33999 39 /******************************************************************************/
<> 149:156823d33999 40 /* Implementation of the runtime max heap usage checker */
<> 149:156823d33999 41 /******************************************************************************/
<> 149:156823d33999 42
<> 149:156823d33999 43 /* Size must be a multiple of 8 to keep alignment */
<> 149:156823d33999 44 typedef struct {
<> 149:156823d33999 45 uint32_t size;
<> 149:156823d33999 46 uint32_t pad;
<> 149:156823d33999 47 } alloc_info_t;
<> 149:156823d33999 48
<> 149:156823d33999 49 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 50 static SingletonPtr<PlatformMutex> mem_trace_mutex;
<> 149:156823d33999 51 #endif
<> 149:156823d33999 52 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 53 static SingletonPtr<PlatformMutex> malloc_stats_mutex;
<> 149:156823d33999 54 static mbed_stats_heap_t heap_stats = {0, 0, 0, 0, 0};
<> 149:156823d33999 55 #endif
<> 149:156823d33999 56
<> 149:156823d33999 57 void mbed_stats_heap_get(mbed_stats_heap_t *stats)
<> 149:156823d33999 58 {
<> 149:156823d33999 59 #ifdef MBED_HEAP_STATS_ENABLED
<> 152:9a67f0b066fc 60 extern uint32_t mbed_heap_size;
<> 152:9a67f0b066fc 61 heap_stats.reserved_size = mbed_heap_size;
<> 152:9a67f0b066fc 62
<> 149:156823d33999 63 malloc_stats_mutex->lock();
<> 149:156823d33999 64 memcpy(stats, &heap_stats, sizeof(mbed_stats_heap_t));
<> 149:156823d33999 65 malloc_stats_mutex->unlock();
<> 149:156823d33999 66 #else
<> 149:156823d33999 67 memset(stats, 0, sizeof(mbed_stats_heap_t));
<> 149:156823d33999 68 #endif
<> 149:156823d33999 69 }
<> 149:156823d33999 70
<> 149:156823d33999 71 /******************************************************************************/
<> 149:156823d33999 72 /* GCC memory allocation wrappers */
<> 149:156823d33999 73 /******************************************************************************/
<> 149:156823d33999 74
<> 149:156823d33999 75 #if defined(TOOLCHAIN_GCC)
<> 149:156823d33999 76
<> 149:156823d33999 77 #ifdef FEATURE_UVISOR
<> 149:156823d33999 78 #include "uvisor-lib/uvisor-lib.h"
<> 149:156823d33999 79 #endif/* FEATURE_UVISOR */
<> 149:156823d33999 80
<> 149:156823d33999 81 extern "C" {
<> 149:156823d33999 82 void * __real__malloc_r(struct _reent * r, size_t size);
AnnaBridge 167:e84263d55307 83 void * __real__memalign_r(struct _reent * r, size_t alignment, size_t bytes);
<> 149:156823d33999 84 void * __real__realloc_r(struct _reent * r, void * ptr, size_t size);
<> 149:156823d33999 85 void __real__free_r(struct _reent * r, void * ptr);
<> 149:156823d33999 86 void* __real__calloc_r(struct _reent * r, size_t nmemb, size_t size);
<> 149:156823d33999 87 }
<> 149:156823d33999 88
<> 149:156823d33999 89 // TODO: memory tracing doesn't work with uVisor enabled.
<> 149:156823d33999 90 #if !defined(FEATURE_UVISOR)
<> 149:156823d33999 91
<> 149:156823d33999 92 extern "C" void * __wrap__malloc_r(struct _reent * r, size_t size) {
<> 149:156823d33999 93 void *ptr = NULL;
<> 149:156823d33999 94 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 95 malloc_stats_mutex->lock();
<> 149:156823d33999 96 alloc_info_t *alloc_info = (alloc_info_t*)__real__malloc_r(r, size + sizeof(alloc_info_t));
<> 149:156823d33999 97 if (alloc_info != NULL) {
<> 149:156823d33999 98 alloc_info->size = size;
<> 149:156823d33999 99 ptr = (void*)(alloc_info + 1);
<> 149:156823d33999 100 heap_stats.current_size += size;
<> 149:156823d33999 101 heap_stats.total_size += size;
<> 149:156823d33999 102 heap_stats.alloc_cnt += 1;
<> 149:156823d33999 103 if (heap_stats.current_size > heap_stats.max_size) {
<> 149:156823d33999 104 heap_stats.max_size = heap_stats.current_size;
<> 149:156823d33999 105 }
<> 149:156823d33999 106 } else {
<> 149:156823d33999 107 heap_stats.alloc_fail_cnt += 1;
<> 149:156823d33999 108 }
<> 149:156823d33999 109 malloc_stats_mutex->unlock();
<> 149:156823d33999 110 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 111 ptr = __real__malloc_r(r, size);
<> 149:156823d33999 112 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 113 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 114 mem_trace_mutex->lock();
<> 149:156823d33999 115 mbed_mem_trace_malloc(ptr, size, MBED_CALLER_ADDR());
<> 149:156823d33999 116 mem_trace_mutex->unlock();
<> 149:156823d33999 117 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 118 return ptr;
<> 149:156823d33999 119 }
<> 149:156823d33999 120
<> 149:156823d33999 121 extern "C" void * __wrap__realloc_r(struct _reent * r, void * ptr, size_t size) {
<> 149:156823d33999 122 void *new_ptr = NULL;
<> 149:156823d33999 123 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 124 // Implement realloc_r with malloc and free.
<> 149:156823d33999 125 // The function realloc_r can't be used here directly since
<> 149:156823d33999 126 // it can call into __wrap__malloc_r (returns ptr + 4) or
<> 149:156823d33999 127 // resize memory directly (returns ptr + 0).
<> 149:156823d33999 128
<> 149:156823d33999 129 // Note - no lock needed since malloc and free are thread safe
<> 149:156823d33999 130
<> 149:156823d33999 131 // Get old size
<> 149:156823d33999 132 uint32_t old_size = 0;
<> 149:156823d33999 133 if (ptr != NULL) {
<> 149:156823d33999 134 alloc_info_t *alloc_info = ((alloc_info_t*)ptr) - 1;
<> 149:156823d33999 135 old_size = alloc_info->size;
<> 149:156823d33999 136 }
<> 149:156823d33999 137
<> 149:156823d33999 138 // Allocate space
<> 149:156823d33999 139 if (size != 0) {
<> 149:156823d33999 140 new_ptr = malloc(size);
<> 149:156823d33999 141 }
<> 149:156823d33999 142
<> 149:156823d33999 143 // If the new buffer has been allocated copy the data to it
<> 149:156823d33999 144 // and free the old buffer
<> 149:156823d33999 145 if (new_ptr != NULL) {
<> 149:156823d33999 146 uint32_t copy_size = (old_size < size) ? old_size : size;
<> 149:156823d33999 147 memcpy(new_ptr, (void*)ptr, copy_size);
<> 149:156823d33999 148 free(ptr);
<> 149:156823d33999 149 }
<> 149:156823d33999 150 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 151 new_ptr = __real__realloc_r(r, ptr, size);
<> 149:156823d33999 152 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 153 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 154 mem_trace_mutex->lock();
<> 149:156823d33999 155 mbed_mem_trace_realloc(new_ptr, ptr, size, MBED_CALLER_ADDR());
<> 149:156823d33999 156 mem_trace_mutex->unlock();
<> 149:156823d33999 157 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 158 return new_ptr;
<> 149:156823d33999 159 }
<> 149:156823d33999 160
<> 149:156823d33999 161 extern "C" void __wrap__free_r(struct _reent * r, void * ptr) {
<> 149:156823d33999 162 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 163 malloc_stats_mutex->lock();
<> 149:156823d33999 164 alloc_info_t *alloc_info = NULL;
<> 149:156823d33999 165 if (ptr != NULL) {
<> 149:156823d33999 166 alloc_info = ((alloc_info_t*)ptr) - 1;
<> 149:156823d33999 167 heap_stats.current_size -= alloc_info->size;
<> 149:156823d33999 168 heap_stats.alloc_cnt -= 1;
<> 149:156823d33999 169 }
<> 149:156823d33999 170 __real__free_r(r, (void*)alloc_info);
<> 149:156823d33999 171 malloc_stats_mutex->unlock();
<> 149:156823d33999 172 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 173 __real__free_r(r, ptr);
<> 149:156823d33999 174 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 175 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 176 mem_trace_mutex->lock();
<> 149:156823d33999 177 mbed_mem_trace_free(ptr, MBED_CALLER_ADDR());
<> 149:156823d33999 178 mem_trace_mutex->unlock();
<> 149:156823d33999 179 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 180 }
<> 149:156823d33999 181
<> 149:156823d33999 182 extern "C" void * __wrap__calloc_r(struct _reent * r, size_t nmemb, size_t size) {
<> 149:156823d33999 183 void *ptr = NULL;
<> 149:156823d33999 184 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 185 // Note - no lock needed since malloc is thread safe
<> 149:156823d33999 186
<> 149:156823d33999 187 ptr = malloc(nmemb * size);
<> 149:156823d33999 188 if (ptr != NULL) {
<> 149:156823d33999 189 memset(ptr, 0, nmemb * size);
<> 149:156823d33999 190 }
<> 149:156823d33999 191 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 192 ptr = __real__calloc_r(r, nmemb, size);
<> 149:156823d33999 193 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 194 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 195 mem_trace_mutex->lock();
<> 149:156823d33999 196 mbed_mem_trace_calloc(ptr, nmemb, size, MBED_CALLER_ADDR());
<> 149:156823d33999 197 mem_trace_mutex->unlock();
<> 149:156823d33999 198 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 199 return ptr;
<> 149:156823d33999 200 }
<> 149:156823d33999 201
AnnaBridge 167:e84263d55307 202 extern "C" void * __wrap__memalign_r(struct _reent * r, size_t alignment, size_t bytes) {
AnnaBridge 167:e84263d55307 203 return __real__memalign_r(r, alignment, bytes);
AnnaBridge 167:e84263d55307 204 }
AnnaBridge 167:e84263d55307 205
AnnaBridge 167:e84263d55307 206 #endif // if !defined(FEATURE_UVISOR)
AnnaBridge 167:e84263d55307 207
<> 149:156823d33999 208
<> 149:156823d33999 209 /******************************************************************************/
<> 149:156823d33999 210 /* ARMCC memory allocation wrappers */
<> 149:156823d33999 211 /******************************************************************************/
<> 149:156823d33999 212
<> 149:156823d33999 213 #elif defined(TOOLCHAIN_ARM) // #if defined(TOOLCHAIN_GCC)
<> 149:156823d33999 214
<> 149:156823d33999 215 /* Enable hooking of memory function only if tracing is also enabled */
<> 149:156823d33999 216 #if defined(MBED_MEM_TRACING_ENABLED) || defined(MBED_HEAP_STATS_ENABLED)
<> 149:156823d33999 217
<> 149:156823d33999 218 extern "C" {
<> 149:156823d33999 219 void *$Super$$malloc(size_t size);
<> 149:156823d33999 220 void *$Super$$realloc(void *ptr, size_t size);
<> 149:156823d33999 221 void *$Super$$calloc(size_t nmemb, size_t size);
<> 149:156823d33999 222 void $Super$$free(void *ptr);
<> 149:156823d33999 223 }
<> 149:156823d33999 224
<> 149:156823d33999 225 extern "C" void* $Sub$$malloc(size_t size) {
<> 149:156823d33999 226 void *ptr = NULL;
<> 149:156823d33999 227 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 228 malloc_stats_mutex->lock();
<> 149:156823d33999 229 alloc_info_t *alloc_info = (alloc_info_t*)$Super$$malloc(size + sizeof(alloc_info_t));
<> 149:156823d33999 230 if (alloc_info != NULL) {
<> 149:156823d33999 231 alloc_info->size = size;
<> 149:156823d33999 232 ptr = (void*)(alloc_info + 1);
<> 149:156823d33999 233 heap_stats.current_size += size;
<> 149:156823d33999 234 heap_stats.total_size += size;
<> 149:156823d33999 235 heap_stats.alloc_cnt += 1;
<> 149:156823d33999 236 if (heap_stats.current_size > heap_stats.max_size) {
<> 149:156823d33999 237 heap_stats.max_size = heap_stats.current_size;
<> 149:156823d33999 238 }
<> 149:156823d33999 239 } else {
<> 149:156823d33999 240 heap_stats.alloc_fail_cnt += 1;
<> 149:156823d33999 241 }
<> 149:156823d33999 242 malloc_stats_mutex->unlock();
<> 149:156823d33999 243 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 244 ptr = $Super$$malloc(size);
<> 149:156823d33999 245 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 246 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 247 mem_trace_mutex->lock();
<> 149:156823d33999 248 mbed_mem_trace_malloc(ptr, size, MBED_CALLER_ADDR());
<> 149:156823d33999 249 mem_trace_mutex->unlock();
<> 149:156823d33999 250 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 251 return ptr;
<> 149:156823d33999 252 }
<> 149:156823d33999 253
<> 149:156823d33999 254 extern "C" void* $Sub$$realloc(void *ptr, size_t size) {
<> 149:156823d33999 255 void *new_ptr = NULL;
<> 149:156823d33999 256 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 257 // Note - no lock needed since malloc and free are thread safe
<> 149:156823d33999 258
<> 149:156823d33999 259 // Get old size
<> 149:156823d33999 260 uint32_t old_size = 0;
<> 149:156823d33999 261 if (ptr != NULL) {
<> 149:156823d33999 262 alloc_info_t *alloc_info = ((alloc_info_t*)ptr) - 1;
<> 149:156823d33999 263 old_size = alloc_info->size;
<> 149:156823d33999 264 }
<> 149:156823d33999 265
<> 149:156823d33999 266 // Allocate space
<> 149:156823d33999 267 if (size != 0) {
<> 149:156823d33999 268 new_ptr = malloc(size);
<> 149:156823d33999 269 }
<> 149:156823d33999 270
<> 149:156823d33999 271 // If the new buffer has been allocated copy the data to it
<> 149:156823d33999 272 // and free the old buffer
<> 149:156823d33999 273 if (new_ptr != NULL) {
<> 149:156823d33999 274 uint32_t copy_size = (old_size < size) ? old_size : size;
<> 149:156823d33999 275 memcpy(new_ptr, (void*)ptr, copy_size);
<> 149:156823d33999 276 free(ptr);
<> 149:156823d33999 277 }
<> 149:156823d33999 278 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 279 new_ptr = $Super$$realloc(ptr, size);
<> 149:156823d33999 280 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 281 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 282 mem_trace_mutex->lock();
<> 149:156823d33999 283 mbed_mem_trace_realloc(new_ptr, ptr, size, MBED_CALLER_ADDR());
<> 149:156823d33999 284 mem_trace_mutex->unlock();
<> 149:156823d33999 285 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 286 return new_ptr;
<> 149:156823d33999 287 }
<> 149:156823d33999 288
<> 149:156823d33999 289 extern "C" void *$Sub$$calloc(size_t nmemb, size_t size) {
<> 149:156823d33999 290 void *ptr = NULL;
<> 149:156823d33999 291 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 292 // Note - no lock needed since malloc is thread safe
<> 149:156823d33999 293 ptr = malloc(nmemb * size);
<> 149:156823d33999 294 if (ptr != NULL) {
<> 149:156823d33999 295 memset(ptr, 0, nmemb * size);
<> 149:156823d33999 296 }
<> 149:156823d33999 297 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 298 ptr = $Super$$calloc(nmemb, size);
<> 149:156823d33999 299 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 300 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 301 mem_trace_mutex->lock();
<> 149:156823d33999 302 mbed_mem_trace_calloc(ptr, nmemb, size, MBED_CALLER_ADDR());
<> 149:156823d33999 303 mem_trace_mutex->unlock();
<> 149:156823d33999 304 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 305 return ptr;
<> 149:156823d33999 306 }
<> 149:156823d33999 307
<> 149:156823d33999 308 extern "C" void $Sub$$free(void *ptr) {
<> 149:156823d33999 309 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 310 malloc_stats_mutex->lock();
<> 149:156823d33999 311 alloc_info_t *alloc_info = NULL;
<> 149:156823d33999 312 if (ptr != NULL) {
<> 149:156823d33999 313 alloc_info = ((alloc_info_t*)ptr) - 1;
<> 149:156823d33999 314 heap_stats.current_size -= alloc_info->size;
<> 149:156823d33999 315 heap_stats.alloc_cnt -= 1;
<> 149:156823d33999 316 }
<> 149:156823d33999 317 $Super$$free((void*)alloc_info);
<> 149:156823d33999 318 malloc_stats_mutex->unlock();
<> 149:156823d33999 319 #else // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 320 $Super$$free(ptr);
<> 149:156823d33999 321 #endif // #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 322 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 323 mem_trace_mutex->lock();
<> 149:156823d33999 324 mbed_mem_trace_free(ptr, MBED_CALLER_ADDR());
<> 149:156823d33999 325 mem_trace_mutex->unlock();
<> 149:156823d33999 326 #endif // #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 327 }
<> 149:156823d33999 328
<> 149:156823d33999 329 #endif // #if defined(MBED_MEM_TRACING_ENABLED) || defined(MBED_HEAP_STATS_ENABLED)
<> 149:156823d33999 330
<> 149:156823d33999 331 /******************************************************************************/
<> 149:156823d33999 332 /* Allocation wrappers for other toolchains are not supported yet */
<> 149:156823d33999 333 /******************************************************************************/
<> 149:156823d33999 334
<> 149:156823d33999 335 #else // #if defined(TOOLCHAIN_GCC)
<> 149:156823d33999 336
<> 149:156823d33999 337 #ifdef MBED_MEM_TRACING_ENABLED
<> 149:156823d33999 338 #warning Memory tracing is not supported with the current toolchain.
<> 149:156823d33999 339 #endif
<> 149:156823d33999 340
<> 149:156823d33999 341 #ifdef MBED_HEAP_STATS_ENABLED
<> 149:156823d33999 342 #warning Heap statistics are not supported with the current toolchain.
<> 149:156823d33999 343 #endif
<> 149:156823d33999 344
<> 149:156823d33999 345 #endif // #if defined(TOOLCHAIN_GCC)
<> 149:156823d33999 346