Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/platform/mbed_mem_trace.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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