mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_stats.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
169:a7c7b631e539
Child:
171:3a7713b1edbc
mbed library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4 /**
AnnaBridge 158:1c57384330a6 5 * \defgroup platform_stats stats functions
AnnaBridge 158:1c57384330a6 6 * @{
AnnaBridge 158:1c57384330a6 7 */
AnnaBridge 156:ff21514d8981 8 /* mbed Microcontroller Library
AnnaBridge 170:e95d10626187 9 * Copyright (c) 2016-2018 ARM Limited
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 12 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 13 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 14 *
AnnaBridge 156:ff21514d8981 15 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 16 *
AnnaBridge 156:ff21514d8981 17 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 18 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 19 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 20 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 21 * limitations under the License.
AnnaBridge 156:ff21514d8981 22 */
AnnaBridge 156:ff21514d8981 23 #ifndef MBED_STATS_H
AnnaBridge 156:ff21514d8981 24 #define MBED_STATS_H
AnnaBridge 156:ff21514d8981 25 #include <stdint.h>
AnnaBridge 156:ff21514d8981 26 #include <stddef.h>
Anna Bridge 169:a7c7b631e539 27 #include "hal/ticker_api.h"
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 30 extern "C" {
AnnaBridge 156:ff21514d8981 31 #endif
AnnaBridge 156:ff21514d8981 32
Anna Bridge 169:a7c7b631e539 33 #ifdef MBED_ALL_STATS_ENABLED
Anna Bridge 169:a7c7b631e539 34 #define MBED_SYS_STATS_ENABLED 1
Anna Bridge 169:a7c7b631e539 35 #define MBED_STACK_STATS_ENABLED 1
Anna Bridge 169:a7c7b631e539 36 #define MBED_CPU_STATS_ENABLED 1
Anna Bridge 169:a7c7b631e539 37 #define MBED_HEAP_STATS_ENABLED 1
Anna Bridge 169:a7c7b631e539 38 #define MBED_THREAD_STATS_ENABLED 1
Anna Bridge 169:a7c7b631e539 39 #endif
Anna Bridge 169:a7c7b631e539 40
AnnaBridge 158:1c57384330a6 41 /**
AnnaBridge 158:1c57384330a6 42 * struct mbed_stats_heap_t definition
AnnaBridge 158:1c57384330a6 43 */
AnnaBridge 156:ff21514d8981 44 typedef struct {
AnnaBridge 156:ff21514d8981 45 uint32_t current_size; /**< Bytes allocated currently. */
AnnaBridge 156:ff21514d8981 46 uint32_t max_size; /**< Max bytes allocated at a given time. */
AnnaBridge 156:ff21514d8981 47 uint32_t total_size; /**< Cumulative sum of bytes ever allocated. */
AnnaBridge 156:ff21514d8981 48 uint32_t reserved_size; /**< Current number of bytes allocated for the heap. */
AnnaBridge 156:ff21514d8981 49 uint32_t alloc_cnt; /**< Current number of allocations. */
AnnaBridge 156:ff21514d8981 50 uint32_t alloc_fail_cnt; /**< Number of failed allocations. */
AnnaBridge 156:ff21514d8981 51 } mbed_stats_heap_t;
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 /**
AnnaBridge 156:ff21514d8981 54 * Fill the passed in heap stat structure with heap stats.
AnnaBridge 156:ff21514d8981 55 *
AnnaBridge 156:ff21514d8981 56 * @param stats A pointer to the mbed_stats_heap_t structure to fill
AnnaBridge 156:ff21514d8981 57 */
AnnaBridge 156:ff21514d8981 58 void mbed_stats_heap_get(mbed_stats_heap_t *stats);
AnnaBridge 156:ff21514d8981 59
AnnaBridge 158:1c57384330a6 60 /**
AnnaBridge 158:1c57384330a6 61 * struct mbed_stats_stack_t definition
AnnaBridge 158:1c57384330a6 62 */
AnnaBridge 156:ff21514d8981 63 typedef struct {
AnnaBridge 156:ff21514d8981 64 uint32_t thread_id; /**< Identifier for thread that owns the stack or 0 if multiple threads. */
AnnaBridge 156:ff21514d8981 65 uint32_t max_size; /**< Maximum number of bytes used on the stack. */
AnnaBridge 156:ff21514d8981 66 uint32_t reserved_size; /**< Current number of bytes allocated for the stack. */
AnnaBridge 156:ff21514d8981 67 uint32_t stack_cnt; /**< Number of stacks stats accumulated in the structure. */
AnnaBridge 156:ff21514d8981 68 } mbed_stats_stack_t;
AnnaBridge 156:ff21514d8981 69
AnnaBridge 156:ff21514d8981 70 /**
AnnaBridge 156:ff21514d8981 71 * Fill the passed in structure with stack stats accumulated for all threads. The thread_id will be 0
AnnaBridge 156:ff21514d8981 72 * and stack_cnt will represent number of threads.
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * @param stats A pointer to the mbed_stats_stack_t structure to fill
AnnaBridge 156:ff21514d8981 75 */
AnnaBridge 156:ff21514d8981 76 void mbed_stats_stack_get(mbed_stats_stack_t *stats);
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78 /**
AnnaBridge 156:ff21514d8981 79 * Fill the passed array of stat structures with the stack stats for each available thread.
AnnaBridge 156:ff21514d8981 80 *
AnnaBridge 156:ff21514d8981 81 * @param stats A pointer to an array of mbed_stats_stack_t structures to fill
AnnaBridge 156:ff21514d8981 82 * @param count The number of mbed_stats_stack_t structures in the provided array
AnnaBridge 156:ff21514d8981 83 * @return The number of mbed_stats_stack_t structures that have been filled,
AnnaBridge 156:ff21514d8981 84 * this is equal to the number of stacks on the system.
AnnaBridge 156:ff21514d8981 85 */
AnnaBridge 156:ff21514d8981 86 size_t mbed_stats_stack_get_each(mbed_stats_stack_t *stats, size_t count);
AnnaBridge 156:ff21514d8981 87
Anna Bridge 169:a7c7b631e539 88 /**
Anna Bridge 169:a7c7b631e539 89 * struct mbed_stats_cpu_t definition
Anna Bridge 169:a7c7b631e539 90 */
Anna Bridge 169:a7c7b631e539 91 typedef struct {
Anna Bridge 169:a7c7b631e539 92 us_timestamp_t uptime; /**< Time since system is up and running */
Anna Bridge 169:a7c7b631e539 93 us_timestamp_t idle_time; /**< Time spent in idle thread since system is up and running */
Anna Bridge 169:a7c7b631e539 94 us_timestamp_t sleep_time; /**< Time spent in sleep since system is up and running */
Anna Bridge 169:a7c7b631e539 95 us_timestamp_t deep_sleep_time; /**< Time spent in deep sleep since system is up and running */
Anna Bridge 169:a7c7b631e539 96 } mbed_stats_cpu_t;
Anna Bridge 169:a7c7b631e539 97
Anna Bridge 169:a7c7b631e539 98 /**
Anna Bridge 169:a7c7b631e539 99 * Fill the passed in CPU stat structure with CPU statistics.
Anna Bridge 169:a7c7b631e539 100 *
Anna Bridge 169:a7c7b631e539 101 * @param stats A pointer to the mbed_stats_cpu_t structure to fill
Anna Bridge 169:a7c7b631e539 102 */
Anna Bridge 169:a7c7b631e539 103 void mbed_stats_cpu_get(mbed_stats_cpu_t *stats);
Anna Bridge 169:a7c7b631e539 104
Anna Bridge 169:a7c7b631e539 105 /**
Anna Bridge 169:a7c7b631e539 106 * struct mbed_stats_thread_t definition
Anna Bridge 169:a7c7b631e539 107 */
Anna Bridge 169:a7c7b631e539 108 typedef struct {
Anna Bridge 169:a7c7b631e539 109 uint32_t id; /**< Thread Object Identifier */
Anna Bridge 169:a7c7b631e539 110 uint32_t state; /**< Thread Object State */
Anna Bridge 169:a7c7b631e539 111 uint32_t priority; /**< Thread Priority */
Anna Bridge 169:a7c7b631e539 112 uint32_t stack_size; /**< Thread Stack Size */
Anna Bridge 169:a7c7b631e539 113 uint32_t stack_space; /**< Thread remaining stack size */
Anna Bridge 169:a7c7b631e539 114 const char *name; /**< Thread Object name */
Anna Bridge 169:a7c7b631e539 115 } mbed_stats_thread_t;
Anna Bridge 169:a7c7b631e539 116
Anna Bridge 169:a7c7b631e539 117 /**
Anna Bridge 169:a7c7b631e539 118 * Fill the passed array of stat structures with the thread stats for each available thread.
Anna Bridge 169:a7c7b631e539 119 *
Anna Bridge 169:a7c7b631e539 120 * @param stats A pointer to an array of mbed_stats_thread_t structures to fill
Anna Bridge 169:a7c7b631e539 121 * @param count The number of mbed_stats_thread_t structures in the provided array
Anna Bridge 169:a7c7b631e539 122 * @return The number of mbed_stats_thread_t structures that have been filled,
Anna Bridge 169:a7c7b631e539 123 * this is equal to the number of threads on the system.
Anna Bridge 169:a7c7b631e539 124 */
Anna Bridge 169:a7c7b631e539 125 size_t mbed_stats_thread_get_each(mbed_stats_thread_t *stats, size_t count);
Anna Bridge 169:a7c7b631e539 126
Anna Bridge 169:a7c7b631e539 127 /**
Anna Bridge 169:a7c7b631e539 128 * enum mbed_compiler_id_t definition
Anna Bridge 169:a7c7b631e539 129 */
Anna Bridge 169:a7c7b631e539 130 typedef enum {
Anna Bridge 169:a7c7b631e539 131 ARM = 1, /**< ARM */
Anna Bridge 169:a7c7b631e539 132 GCC_ARM, /**< GNU ARM */
Anna Bridge 169:a7c7b631e539 133 IAR /**< IAR */
Anna Bridge 169:a7c7b631e539 134 } mbed_compiler_id_t;
Anna Bridge 169:a7c7b631e539 135
Anna Bridge 169:a7c7b631e539 136 /**
Anna Bridge 169:a7c7b631e539 137 * struct mbed_stats_sys_t definition
Anna Bridge 169:a7c7b631e539 138 */
Anna Bridge 169:a7c7b631e539 139 typedef struct {
Anna Bridge 169:a7c7b631e539 140 uint32_t os_version; /**< Mbed OS Version (Release only) */
Anna Bridge 169:a7c7b631e539 141 uint32_t cpu_id; /**< CPUID Register data (Cortex-M only supported) */
Anna Bridge 169:a7c7b631e539 142 mbed_compiler_id_t compiler_id; /**< Compiler ID \ref mbed_compiler_id_t */
Anna Bridge 169:a7c7b631e539 143 uint32_t compiler_version; /**< Compiler version */
Anna Bridge 169:a7c7b631e539 144 } mbed_stats_sys_t;
Anna Bridge 169:a7c7b631e539 145
Anna Bridge 169:a7c7b631e539 146 /**
Anna Bridge 169:a7c7b631e539 147 * Fill the passed in sys stat structure with system stats.
Anna Bridge 169:a7c7b631e539 148 *
Anna Bridge 169:a7c7b631e539 149 * @param stats A pointer to the mbed_stats_sys_t structure to fill
Anna Bridge 169:a7c7b631e539 150 */
Anna Bridge 169:a7c7b631e539 151 void mbed_stats_sys_get(mbed_stats_sys_t *stats);
Anna Bridge 169:a7c7b631e539 152
AnnaBridge 156:ff21514d8981 153 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 154 }
AnnaBridge 156:ff21514d8981 155 #endif
AnnaBridge 156:ff21514d8981 156
AnnaBridge 156:ff21514d8981 157 #endif
AnnaBridge 156:ff21514d8981 158
AnnaBridge 156:ff21514d8981 159 /** @}*/
AnnaBridge 158:1c57384330a6 160
AnnaBridge 158:1c57384330a6 161 /** @}*/