Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

platform/mbed_mem_trace.h@3:993b4d6ff61e, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:33:24 2021 +0000
Revision:
3:993b4d6ff61e
Parent:
0:083111ae2a11 
added CAN3

Who changed what in which revision?

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