Mbed OS Reference
Loading...
Searching...
No Matches
stats functions

Data Structures

struct  mbed_stats_heap_t
 struct mbed_stats_heap_t definition More...
 
struct  mbed_stats_stack_t
 struct mbed_stats_stack_t definition More...
 
struct  mbed_stats_cpu_t
 struct mbed_stats_cpu_t definition More...
 
struct  mbed_stats_thread_t
 struct mbed_stats_thread_t definition More...
 
struct  mbed_stats_sys_t
 struct mbed_stats_sys_t definition More...
 

Macros

#define MBED_MAX_MEM_REGIONS   4
 Maximum memory regions reported by mbed-os memory statistics. More...
 

Enumerations

enum  mbed_compiler_id_t { ARM = 1 , GCC_ARM , IAR }
 enum mbed_compiler_id_t definition More...
 

Functions

void mbed_stats_heap_get (mbed_stats_heap_t *stats)
 Fill the passed in heap stat structure with the heap statistics. More...
 
void mbed_stats_stack_get (mbed_stats_stack_t *stats)
 Fill the passed in structure with stack statistics accumulated for all threads. More...
 
size_t mbed_stats_stack_get_each (mbed_stats_stack_t *stats, size_t count)
 Fill the passed array of structures with the stack statistics for each available thread. More...
 
void mbed_stats_cpu_get (mbed_stats_cpu_t *stats)
 Fill the passed in CPU stat structure with CPU statistics. More...
 
size_t mbed_stats_thread_get_each (mbed_stats_thread_t *stats, size_t count)
 Fill the passed array of stat structures with the thread statistics for each available thread. More...
 
void mbed_stats_sys_get (mbed_stats_sys_t *stats)
 Fill the passed in system stat structure with system statistics. More...
 

Detailed Description

Macro Definition Documentation

◆ MBED_MAX_MEM_REGIONS

#define MBED_MAX_MEM_REGIONS   4

Maximum memory regions reported by mbed-os memory statistics.

Definition at line 56 of file mbed_stats.h.

Enumeration Type Documentation

◆ mbed_compiler_id_t

enum mbed_compiler_id_t definition

Enumerator
ARM 

ARM.

GCC_ARM 

GNU ARM.

IAR 

IAR.

Definition at line 150 of file mbed_stats.h.

Function Documentation

◆ mbed_stats_heap_get()

void mbed_stats_heap_get ( mbed_stats_heap_t stats)

Fill the passed in heap stat structure with the heap statistics.

Parameters
statsA pointer to the mbed_stats_heap_t structure to fill

◆ mbed_stats_stack_get()

void mbed_stats_stack_get ( mbed_stats_stack_t stats)

Fill the passed in structure with stack statistics accumulated for all threads.

The thread_id will be 0 and stack_cnt will represent number of threads.

Parameters
statsA pointer to the mbed_stats_stack_t structure to fill

◆ mbed_stats_stack_get_each()

size_t mbed_stats_stack_get_each ( mbed_stats_stack_t stats,
size_t  count 
)

Fill the passed array of structures with the stack statistics for each available thread.

Parameters
statsA pointer to an array of mbed_stats_stack_t structures to fill
countThe number of mbed_stats_stack_t structures in the provided array
Returns
The number of mbed_stats_stack_t structures that have been filled. If the number of stacks on the system is less than or equal to count, it will equal the number of stacks on the system. If the number of stacks on the system is greater than count, it will equal count.

◆ mbed_stats_cpu_get()

void mbed_stats_cpu_get ( mbed_stats_cpu_t stats)

Fill the passed in CPU stat structure with CPU statistics.

Parameters
statsA pointer to the mbed_stats_cpu_t structure to fill

◆ mbed_stats_thread_get_each()

size_t mbed_stats_thread_get_each ( mbed_stats_thread_t stats,
size_t  count 
)

Fill the passed array of stat structures with the thread statistics for each available thread.

Parameters
statsA pointer to an array of mbed_stats_thread_t structures to fill
countThe number of mbed_stats_thread_t structures in the provided array
Returns
The number of mbed_stats_thread_t structures that have been filled. If the number of threads on the system is less than or equal to count, it will equal the number of threads on the system. If the number of threads on the system is greater than count, it will equal count.

◆ mbed_stats_sys_get()

void mbed_stats_sys_get ( mbed_stats_sys_t stats)

Fill the passed in system stat structure with system statistics.

Parameters
statsA pointer to the mbed_stats_sys_t structure to fill