mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_mem_trace.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4
AnnaBridge 156:ff21514d8981 5 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 6 * Copyright (c) 2006-2016 ARM Limited
AnnaBridge 172:65be27845400 7 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 10 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 11 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 16 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 18 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 19 * limitations under the License.
AnnaBridge 156:ff21514d8981 20 */
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #ifndef __MBED_MEM_TRACE_H__
AnnaBridge 156:ff21514d8981 23 #define __MBED_MEM_TRACE_H__
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 26 extern "C" {
AnnaBridge 156:ff21514d8981 27 #endif
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 #include <stdint.h>
AnnaBridge 156:ff21514d8981 30 #include <stddef.h>
AnnaBridge 156:ff21514d8981 31
AnnaBridge 171:3a7713b1edbc 32 /**
AnnaBridge 171:3a7713b1edbc 33 * enum Memory operation types for tracer
AnnaBridge 172:65be27845400 34 */
AnnaBridge 156:ff21514d8981 35 enum {
AnnaBridge 171:3a7713b1edbc 36 MBED_MEM_TRACE_MALLOC, /**< Identifier for malloc operation */
AnnaBridge 171:3a7713b1edbc 37 MBED_MEM_TRACE_REALLOC, /**< Identifier for realloc operation */
AnnaBridge 171:3a7713b1edbc 38 MBED_MEM_TRACE_CALLOC, /**< Identifier for calloc operation */
AnnaBridge 171:3a7713b1edbc 39 MBED_MEM_TRACE_FREE /**< Identifier for free operation */
AnnaBridge 156:ff21514d8981 40 };
AnnaBridge 156:ff21514d8981 41
AnnaBridge 158:1c57384330a6 42 /**
AnnaBridge 158:1c57384330a6 43 * \defgroup platform_mem_trace mem_trace functions
AnnaBridge 158:1c57384330a6 44 * @{
AnnaBridge 158:1c57384330a6 45 */
AnnaBridge 158:1c57384330a6 46
AnnaBridge 156:ff21514d8981 47 /* Prefix for the output of the default tracer */
AnnaBridge 156:ff21514d8981 48 #define MBED_MEM_DEFAULT_TRACER_PREFIX "#"
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 /**
AnnaBridge 156:ff21514d8981 51 * Type of the callback used by the memory tracer. This callback is called when a memory
AnnaBridge 156:ff21514d8981 52 * allocation operation (malloc, realloc, calloc, free) is called and tracing is enabled
AnnaBridge 156:ff21514d8981 53 * for that memory allocation function.
AnnaBridge 156:ff21514d8981 54 *
AnnaBridge 156:ff21514d8981 55 * @param op the ID of the operation (MBED_MEM_TRACE_MALLOC, MBED_MEM_TRACE_REALLOC,
AnnaBridge 156:ff21514d8981 56 * MBED_MEM_TRACE_CALLOC or MBED_MEM_TRACE_FREE).
AnnaBridge 156:ff21514d8981 57 * @param res the result that the memory operation returned (NULL for 'free').
AnnaBridge 156:ff21514d8981 58 * @param caller the caller of the memory operation. Note that the value of 'caller' might be
AnnaBridge 156:ff21514d8981 59 * unreliable.
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * The rest of the parameters passed 'mbed_mem_trace_cb_t' are the same as the memory operations
AnnaBridge 156:ff21514d8981 62 * that triggered its call (see 'man malloc' for details):
AnnaBridge 156:ff21514d8981 63 *
AnnaBridge 156:ff21514d8981 64 * - for malloc: cb(MBED_MEM_TRACE_MALLOC, res, caller, size).
AnnaBridge 156:ff21514d8981 65 * - for realloc: cb(MBED_MEM_TRACE_REALLOC, res, caller, ptr, size).
AnnaBridge 156:ff21514d8981 66 * - for calloc: cb(MBED_MEM_TRACE_CALLOC, res, caller, nmemb, size).
AnnaBridge 156:ff21514d8981 67 * - for free: cb(MBED_MEM_TRACE_FREE, NULL, caller, ptr).
AnnaBridge 156:ff21514d8981 68 */
AnnaBridge 170:e95d10626187 69 typedef void (*mbed_mem_trace_cb_t)(uint8_t op, void *res, void *caller, ...);
AnnaBridge 156:ff21514d8981 70
AnnaBridge 156:ff21514d8981 71 /**
AnnaBridge 156:ff21514d8981 72 * Set the callback used by the memory tracer (use NULL for disable tracing).
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * @param cb the callback to call on each memory operation.
AnnaBridge 156:ff21514d8981 75 */
AnnaBridge 156:ff21514d8981 76 void mbed_mem_trace_set_callback(mbed_mem_trace_cb_t cb);
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 /**
AnnaBridge 172:65be27845400 79 * Disable the memory trace output by disabling the callback function
AnnaBridge 172:65be27845400 80 */
AnnaBridge 172:65be27845400 81 void mbed_mem_trace_disable();
AnnaBridge 172:65be27845400 82
AnnaBridge 172:65be27845400 83 /**
AnnaBridge 172:65be27845400 84 * Re-enable the memory trace output with the cb in use when disable was called
AnnaBridge 172:65be27845400 85 */
AnnaBridge 172:65be27845400 86 void mbed_mem_trace_enable();
AnnaBridge 172:65be27845400 87
AnnaBridge 172:65be27845400 88 /**
Anna Bridge 160:5571c4ff569f 89 * Trace lock.
AnnaBridge 172:65be27845400 90 * @note Locking prevent recursive tracing of malloc/free inside realloc/calloc
Anna Bridge 160:5571c4ff569f 91 */
Anna Bridge 160:5571c4ff569f 92 void mbed_mem_trace_lock();
Anna Bridge 160:5571c4ff569f 93
Anna Bridge 160:5571c4ff569f 94 /**
Anna Bridge 160:5571c4ff569f 95 * Trace unlock.
Anna Bridge 160:5571c4ff569f 96 */
Anna Bridge 160:5571c4ff569f 97 void mbed_mem_trace_unlock();
Anna Bridge 160:5571c4ff569f 98
Anna Bridge 160:5571c4ff569f 99 /**
AnnaBridge 156:ff21514d8981 100 * Trace a call to 'malloc'.
AnnaBridge 156:ff21514d8981 101 * @param res the result of running 'malloc'.
AnnaBridge 156:ff21514d8981 102 * @param size the 'size' argument given to 'malloc'.
AnnaBridge 156:ff21514d8981 103 * @param caller the caller of the memory operation.
AnnaBridge 156:ff21514d8981 104 * @return 'res' (the first argument).
AnnaBridge 156:ff21514d8981 105 */
AnnaBridge 156:ff21514d8981 106 void *mbed_mem_trace_malloc(void *res, size_t size, void *caller);
AnnaBridge 156:ff21514d8981 107
AnnaBridge 156:ff21514d8981 108 /**
AnnaBridge 156:ff21514d8981 109 * Trace a call to 'realloc'.
AnnaBridge 156:ff21514d8981 110 * @param res the result of running 'realloc'.
AnnaBridge 156:ff21514d8981 111 * @param ptr the 'ptr' argument given to 'realloc'.
AnnaBridge 156:ff21514d8981 112 * @param size the 'size' argument given to 'realloc'.
AnnaBridge 156:ff21514d8981 113 * @param caller the caller of the memory operation.
AnnaBridge 156:ff21514d8981 114 * @return 'res' (the first argument).
AnnaBridge 156:ff21514d8981 115 */
AnnaBridge 156:ff21514d8981 116 void *mbed_mem_trace_realloc(void *res, void *ptr, size_t size, void *caller);
AnnaBridge 156:ff21514d8981 117
AnnaBridge 156:ff21514d8981 118 /**
AnnaBridge 156:ff21514d8981 119 * Trace a call to 'calloc'.
AnnaBridge 156:ff21514d8981 120 * @param res the result of running 'calloc'.
AnnaBridge 156:ff21514d8981 121 * @param num the 'nmemb' argument given to 'calloc'.
AnnaBridge 156:ff21514d8981 122 * @param size the 'size' argument given to 'calloc'.
AnnaBridge 156:ff21514d8981 123 * @param caller the caller of the memory operation.
AnnaBridge 156:ff21514d8981 124 * @return 'res' (the first argument).
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 void *mbed_mem_trace_calloc(void *res, size_t num, size_t size, void *caller);
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /**
AnnaBridge 156:ff21514d8981 129 * Trace a call to 'free'.
AnnaBridge 156:ff21514d8981 130 * @param ptr the 'ptr' argument given to 'free'.
AnnaBridge 156:ff21514d8981 131 * @param caller the caller of the memory operation.
AnnaBridge 156:ff21514d8981 132 */
AnnaBridge 156:ff21514d8981 133 void mbed_mem_trace_free(void *ptr, void *caller);
AnnaBridge 156:ff21514d8981 134
AnnaBridge 156:ff21514d8981 135 /**
AnnaBridge 156:ff21514d8981 136 * Default memory trace callback. DO NOT CALL DIRECTLY. It is meant to be used
AnnaBridge 156:ff21514d8981 137 * as the second argument of 'mbed_mem_trace_setup'.
AnnaBridge 156:ff21514d8981 138 *
AnnaBridge 156:ff21514d8981 139 * The default callback outputs trace data using 'printf', in a format that's
AnnaBridge 156:ff21514d8981 140 * easily parsable by an external tool. For each memory operation, the callback
AnnaBridge 156:ff21514d8981 141 * outputs a line that begins with "#<op>:<0xresult>;<0xcaller>-":
AnnaBridge 156:ff21514d8981 142 *
AnnaBridge 156:ff21514d8981 143 * @param op identifies the memory operation ('m' for 'malloc', 'r' for 'realloc',
AnnaBridge 156:ff21514d8981 144 * 'c' for 'calloc' and 'f' for 'free').
AnnaBridge 172:65be27845400 145 * @param res (base 16) is the result of the memory operation. This is always NULL
AnnaBridge 156:ff21514d8981 146 * for 'free', since 'free' doesn't return anything.
AnnaBridge 156:ff21514d8981 147 * @param caller (base 16) is the caller of the memory operation. Note that the value
AnnaBridge 156:ff21514d8981 148 * of 'caller' might be unreliable.
AnnaBridge 156:ff21514d8981 149 *
AnnaBridge 156:ff21514d8981 150 * The rest of the output depends on the operation being traced:
AnnaBridge 156:ff21514d8981 151 *
AnnaBridge 156:ff21514d8981 152 * - for 'malloc': 'size', where 'size' is the original argument to 'malloc'.
AnnaBridge 156:ff21514d8981 153 * - for 'realloc': '0xptr;size', where 'ptr' (base 16) and 'size' are the original arguments to 'realloc'.
AnnaBridge 156:ff21514d8981 154 * - for 'calloc': 'nmemb;size', where 'nmemb' and 'size' are the original arguments to 'calloc'.
AnnaBridge 156:ff21514d8981 155 * - for 'free': '0xptr', where 'ptr' (base 16) is the original argument to 'free'.
AnnaBridge 156:ff21514d8981 156 *
AnnaBridge 156:ff21514d8981 157 * Examples:
AnnaBridge 156:ff21514d8981 158 *
AnnaBridge 156:ff21514d8981 159 * - "#m:0x20003240;0x600d-50" encodes a 'malloc' that returned 0x20003240, was called
AnnaBridge 156:ff21514d8981 160 * by the instruction at 0x600D with a the 'size' argument equal to 50.
AnnaBridge 156:ff21514d8981 161 * - "#f:0x0;0x602f-0x20003240" encodes a 'free' that was called by the instruction at
AnnaBridge 156:ff21514d8981 162 * 0x602f with the 'ptr' argument equal to 0x20003240.
AnnaBridge 156:ff21514d8981 163 */
AnnaBridge 156:ff21514d8981 164 void mbed_mem_trace_default_callback(uint8_t op, void *res, void *caller, ...);
AnnaBridge 156:ff21514d8981 165
AnnaBridge 158:1c57384330a6 166 /** @}*/
AnnaBridge 158:1c57384330a6 167
AnnaBridge 156:ff21514d8981 168 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 169 }
AnnaBridge 156:ff21514d8981 170 #endif
AnnaBridge 156:ff21514d8981 171
AnnaBridge 156:ff21514d8981 172 #endif// #ifndef __MBED_MEM_TRACE_H__
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174
AnnaBridge 156:ff21514d8981 175 /** @}*/