Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/mbed_mem_trace.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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