Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

platform/mbed_stats.h@165:2dd56e6daeec, 2017-05-23 (annotated)

Committer:
ranaumarnaeem
Date:
Tue May 23 12:54:50 2017 +0000
Revision:
165:2dd56e6daeec
Parent:
152:9a67f0b066fc 
jhjg

Who changed what in which revision?

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