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@148:fd96258d940d, 2017-08-03 (annotated)

Committer:
Kojto
Date:
Thu Aug 03 13:37:00 2017 +0100
Revision:
148:fd96258d940d
Parent:
131:faff56e089b2 
Release 148 of the mbed library.

Who changed what in which revision?

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