zhang boie / mbed-dev-f30333

platform/mbed_mem_trace.c@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 1 /* mbed Microcontroller Library
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 2 * Copyright (c) 2006-2016 ARM Limited
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 3 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 4 * Licensed under the Apache License, Version 2.0 (the "License");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 5 * you may not use this file except in compliance with the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 6 * You may obtain a copy of the License at
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 7 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 8 * http://www.apache.org/licenses/LICENSE-2.0
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 9 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 10 * Unless required by applicable law or agreed to in writing, software
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 11 * distributed under the License is distributed on an "AS IS" BASIS,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 13 * See the License for the specific language governing permissions and
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 14 * limitations under the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 15 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 16
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 17 #include <stdlib.h>
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 18 #include <stdarg.h>
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 19 #include <stdio.h>
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 20 #include "platform/mbed_mem_trace.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 21 #include "platform/mbed_critical.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 22
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 23 /******************************************************************************
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 24 * Internal variables, functions and helpers
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 25 *****************************************************************************/
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 26
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 27 /* The callback function that will be called after a traced memory operations finishes. */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 28 static mbed_mem_trace_cb_t mem_trace_cb;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 29 /* 'trave_level' guards "trace inside trace" situations (for example, the implementation
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 30 * of realloc() might call malloc() internally, and since malloc() is also traced, this could
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 31 * result in two calls to the callback function instead of one. */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 32 static uint8_t trace_level;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 33
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 34 /******************************************************************************
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 35 * Public interface
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 36 *****************************************************************************/
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 37
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 38 void mbed_mem_trace_set_callback(mbed_mem_trace_cb_t cb) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 39 mem_trace_cb = cb;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 40 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 41
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 42 void *mbed_mem_trace_malloc(void *res, size_t size, void *caller) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 43 if (mem_trace_cb) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 44 if (core_util_atomic_incr_u8(&trace_level, 1) == 1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 45 mem_trace_cb(MBED_MEM_TRACE_MALLOC, res, caller, size);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 46 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 47 core_util_atomic_decr_u8(&trace_level, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 48 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 49 return res;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 50 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 51
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 52 void *mbed_mem_trace_realloc(void *res, void *ptr, size_t size, void *caller) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 53 if (mem_trace_cb) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 54 if (core_util_atomic_incr_u8(&trace_level, 1) == 1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 55 mem_trace_cb(MBED_MEM_TRACE_REALLOC, res, caller, ptr, size);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 56 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 57 core_util_atomic_decr_u8(&trace_level, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 58 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 59 return res;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 60 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 61
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 62 void *mbed_mem_trace_calloc(void *res, size_t num, size_t size, void *caller) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 63 if (mem_trace_cb) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 64 if (core_util_atomic_incr_u8(&trace_level, 1) == 1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 65 mem_trace_cb(MBED_MEM_TRACE_CALLOC, res, caller, num, size);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 66 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 67 core_util_atomic_decr_u8(&trace_level, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 68 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 69 return res;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 70 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 71
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 72 void mbed_mem_trace_free(void *ptr, void *caller) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 73 if (mem_trace_cb) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 74 if (core_util_atomic_incr_u8(&trace_level, 1) == 1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 75 mem_trace_cb(MBED_MEM_TRACE_FREE, NULL, caller, ptr);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 76 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 77 core_util_atomic_decr_u8(&trace_level, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 78 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 79 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 80
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 81 void mbed_mem_trace_default_callback(uint8_t op, void *res, void *caller, ...) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 82 va_list va;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 83 size_t temp_s1, temp_s2;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 84 void *temp_ptr;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 85
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 86 va_start(va, caller);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 87 switch(op) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 88 case MBED_MEM_TRACE_MALLOC:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 89 temp_s1 = va_arg(va, size_t);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 90 printf(MBED_MEM_DEFAULT_TRACER_PREFIX "m:%p;%p-%u\n", res, caller, temp_s1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 91 break;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 92
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 93 case MBED_MEM_TRACE_REALLOC:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 94 temp_ptr = va_arg(va, void*);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 95 temp_s1 = va_arg(va, size_t);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 96 printf(MBED_MEM_DEFAULT_TRACER_PREFIX "r:%p;%p-%p;%u\n", res, caller, temp_ptr, temp_s1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 97 break;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 98
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 99 case MBED_MEM_TRACE_CALLOC:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 100 temp_s1 = va_arg(va, size_t);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 101 temp_s2 = va_arg(va, size_t);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 102 printf(MBED_MEM_DEFAULT_TRACER_PREFIX "c:%p;%p-%u;%u\n", res, caller, temp_s1, temp_s2);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 103 break;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 104
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 105 case MBED_MEM_TRACE_FREE:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 106 temp_ptr = va_arg(va, void*);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 107 printf(MBED_MEM_DEFAULT_TRACER_PREFIX "f:%p;%p-%p\n", res, caller, temp_ptr);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 108 break;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 109
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 110 default:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 111 printf("?\n");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 112 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 113 va_end(va);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 114 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 115
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 116