Pedro Correia / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

platform/mbed_stats.h@178:79309dc6340a, 2017-11-23 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 23 11:57:25 2017 +0000
Revision:
178:79309dc6340a
Parent:
170:19eb464bc2be
Child:
186:707f6e361f3e
mbed-dev library. Release version 156

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1
<> 149:156823d33999 2 /** \addtogroup platform */
<> 149:156823d33999 3 /** @{*/
AnnaBridge 178:79309dc6340a 4 /**
AnnaBridge 178:79309dc6340a 5 * \defgroup platform_stats stats functions
AnnaBridge 178:79309dc6340a 6 * @{
AnnaBridge 178:79309dc6340a 7 */
<> 149:156823d33999 8 /* mbed Microcontroller Library
<> 149:156823d33999 9 * Copyright (c) 2016-2016 ARM Limited
<> 149:156823d33999 10 *
<> 149:156823d33999 11 * Licensed under the Apache License, Version 2.0 (the "License");
<> 149:156823d33999 12 * you may not use this file except in compliance with the License.
<> 149:156823d33999 13 * You may obtain a copy of the License at
<> 149:156823d33999 14 *
<> 149:156823d33999 15 * http://www.apache.org/licenses/LICENSE-2.0
<> 149:156823d33999 16 *
<> 149:156823d33999 17 * Unless required by applicable law or agreed to in writing, software
<> 149:156823d33999 18 * distributed under the License is distributed on an "AS IS" BASIS,
<> 149:156823d33999 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 149:156823d33999 20 * See the License for the specific language governing permissions and
<> 149:156823d33999 21 * limitations under the License.
<> 149:156823d33999 22 */
<> 149:156823d33999 23 #ifndef MBED_STATS_H
<> 149:156823d33999 24 #define MBED_STATS_H
<> 152:9a67f0b066fc 25 #include <stdint.h>
<> 152:9a67f0b066fc 26 #include <stddef.h>
<> 149:156823d33999 27
<> 149:156823d33999 28 #ifdef __cplusplus
<> 149:156823d33999 29 extern "C" {
<> 149:156823d33999 30 #endif
<> 149:156823d33999 31
AnnaBridge 178:79309dc6340a 32 /**
AnnaBridge 178:79309dc6340a 33 * struct mbed_stats_heap_t definition
AnnaBridge 178:79309dc6340a 34 */
<> 149:156823d33999 35 typedef struct {
<> 149:156823d33999 36 uint32_t current_size; /**< Bytes allocated currently. */
<> 149:156823d33999 37 uint32_t max_size; /**< Max bytes allocated at a given time. */
<> 149:156823d33999 38 uint32_t total_size; /**< Cumulative sum of bytes ever allocated. */
<> 152:9a67f0b066fc 39 uint32_t reserved_size; /**< Current number of bytes allocated for the heap. */
<> 149:156823d33999 40 uint32_t alloc_cnt; /**< Current number of allocations. */
<> 149:156823d33999 41 uint32_t alloc_fail_cnt; /**< Number of failed allocations. */
<> 149:156823d33999 42 } mbed_stats_heap_t;
<> 149:156823d33999 43
<> 149:156823d33999 44 /**
<> 152:9a67f0b066fc 45 * Fill the passed in heap stat structure with heap stats.
<> 152:9a67f0b066fc 46 *
<> 152:9a67f0b066fc 47 * @param stats A pointer to the mbed_stats_heap_t structure to fill
<> 149:156823d33999 48 */
<> 149:156823d33999 49 void mbed_stats_heap_get(mbed_stats_heap_t *stats);
<> 149:156823d33999 50
AnnaBridge 178:79309dc6340a 51 /**
AnnaBridge 178:79309dc6340a 52 * struct mbed_stats_stack_t definition
AnnaBridge 178:79309dc6340a 53 */
<> 152:9a67f0b066fc 54 typedef struct {
Kojto 170:19eb464bc2be 55 uint32_t thread_id; /**< Identifier for thread that owns the stack or 0 if multiple threads. */
Kojto 170:19eb464bc2be 56 uint32_t max_size; /**< Maximum number of bytes used on the stack. */
Kojto 170:19eb464bc2be 57 uint32_t reserved_size; /**< Current number of bytes allocated for the stack. */
Kojto 170:19eb464bc2be 58 uint32_t stack_cnt; /**< Number of stacks stats accumulated in the structure. */
<> 152:9a67f0b066fc 59 } mbed_stats_stack_t;
<> 152:9a67f0b066fc 60
<> 152:9a67f0b066fc 61 /**
Kojto 170:19eb464bc2be 62 * Fill the passed in structure with stack stats accumulated for all threads. The thread_id will be 0
Kojto 170:19eb464bc2be 63 * and stack_cnt will represent number of threads.
<> 152:9a67f0b066fc 64 *
<> 152:9a67f0b066fc 65 * @param stats A pointer to the mbed_stats_stack_t structure to fill
<> 152:9a67f0b066fc 66 */
<> 152:9a67f0b066fc 67 void mbed_stats_stack_get(mbed_stats_stack_t *stats);
<> 152:9a67f0b066fc 68
<> 152:9a67f0b066fc 69 /**
Kojto 170:19eb464bc2be 70 * Fill the passed array of stat structures with the stack stats for each available thread.
<> 152:9a67f0b066fc 71 *
<> 152:9a67f0b066fc 72 * @param stats A pointer to an array of mbed_stats_stack_t structures to fill
<> 152:9a67f0b066fc 73 * @param count The number of mbed_stats_stack_t structures in the provided array
<> 152:9a67f0b066fc 74 * @return The number of mbed_stats_stack_t structures that have been filled,
<> 152:9a67f0b066fc 75 * this is equal to the number of stacks on the system.
<> 152:9a67f0b066fc 76 */
<> 152:9a67f0b066fc 77 size_t mbed_stats_stack_get_each(mbed_stats_stack_t *stats, size_t count);
<> 152:9a67f0b066fc 78
<> 149:156823d33999 79 #ifdef __cplusplus
<> 149:156823d33999 80 }
<> 149:156823d33999 81 #endif
<> 149:156823d33999 82
<> 149:156823d33999 83 #endif
<> 149:156823d33999 84
<> 149:156823d33999 85 /** @}*/
AnnaBridge 178:79309dc6340a 86
AnnaBridge 178:79309dc6340a 87 /** @}*/