minh hien / Mbed OS mbed-os-example-blinky

1

stats_report.h@0:1cb528f651d6, 2019-09-10 (annotated)

Committer:
taminhhien
Date:
Tue Sep 10 06:41:16 2019 +0000
Revision:
0:1cb528f651d6
123

Who changed what in which revision?

UserRevisionLine numberNew contents of line
taminhhien 0:1cb528f651d6 1 /* mbed Microcontroller Library
taminhhien 0:1cb528f651d6 2 * Copyright (c) 2018 ARM Limited
taminhhien 0:1cb528f651d6 3 * SPDX-License-Identifier: Apache-2.0
taminhhien 0:1cb528f651d6 4 */
taminhhien 0:1cb528f651d6 5
taminhhien 0:1cb528f651d6 6 #ifndef STATS_REPORT_H
taminhhien 0:1cb528f651d6 7 #define STATS_REPORT_H
taminhhien 0:1cb528f651d6 8
taminhhien 0:1cb528f651d6 9 #include <inttypes.h>
taminhhien 0:1cb528f651d6 10 #include "mbed.h"
taminhhien 0:1cb528f651d6 11
taminhhien 0:1cb528f651d6 12 /**
taminhhien 0:1cb528f651d6 13 * System Reporting library. Provides runtime information on device:
taminhhien 0:1cb528f651d6 14 * - CPU sleep, idle, and wake times
taminhhien 0:1cb528f651d6 15 * - Heap and stack usage
taminhhien 0:1cb528f651d6 16 * - Thread information
taminhhien 0:1cb528f651d6 17 * - Static system information
taminhhien 0:1cb528f651d6 18 */
taminhhien 0:1cb528f651d6 19 class SystemReport {
taminhhien 0:1cb528f651d6 20 mbed_stats_heap_t heap_stats;
taminhhien 0:1cb528f651d6 21 mbed_stats_cpu_t cpu_stats;
taminhhien 0:1cb528f651d6 22 mbed_stats_sys_t sys_stats;
taminhhien 0:1cb528f651d6 23
taminhhien 0:1cb528f651d6 24 mbed_stats_thread_t *thread_stats;
taminhhien 0:1cb528f651d6 25 uint8_t thread_count;
taminhhien 0:1cb528f651d6 26 uint8_t max_thread_count;
taminhhien 0:1cb528f651d6 27 uint32_t sample_time_ms;
taminhhien 0:1cb528f651d6 28
taminhhien 0:1cb528f651d6 29 public:
taminhhien 0:1cb528f651d6 30 /**
taminhhien 0:1cb528f651d6 31 * SystemReport - Sample rate in ms is required to handle the CPU percent awake logic
taminhhien 0:1cb528f651d6 32 */
taminhhien 0:1cb528f651d6 33 SystemReport(uint32_t sample_rate) : max_thread_count(8), sample_time_ms(sample_rate)
taminhhien 0:1cb528f651d6 34 {
taminhhien 0:1cb528f651d6 35 thread_stats = new mbed_stats_thread_t[max_thread_count];
taminhhien 0:1cb528f651d6 36
taminhhien 0:1cb528f651d6 37 // Collect the static system information
taminhhien 0:1cb528f651d6 38 mbed_stats_sys_get(&sys_stats);
taminhhien 0:1cb528f651d6 39
taminhhien 0:1cb528f651d6 40 printf("=============================== SYSTEM INFO ================================\r\n");
taminhhien 0:1cb528f651d6 41 printf("Mbed OS Version: %" PRIu32 " \r\n", sys_stats.os_version);
taminhhien 0:1cb528f651d6 42 printf("CPU ID: 0x%" PRIx32 " \r\n", sys_stats.cpu_id);
taminhhien 0:1cb528f651d6 43 printf("Compiler ID: %d \r\n", sys_stats.compiler_id);
taminhhien 0:1cb528f651d6 44 printf("Compiler Version: %" PRIu32 " \r\n", sys_stats.compiler_version);
taminhhien 0:1cb528f651d6 45
taminhhien 0:1cb528f651d6 46 for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) {
taminhhien 0:1cb528f651d6 47 if (sys_stats.ram_size[i] != 0) {
taminhhien 0:1cb528f651d6 48 printf("RAM%d: Start 0x%" PRIx32 " Size: 0x%" PRIx32 " \r\n", i, sys_stats.ram_start[i], sys_stats.ram_size[i]);
taminhhien 0:1cb528f651d6 49 }
taminhhien 0:1cb528f651d6 50 }
taminhhien 0:1cb528f651d6 51 for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) {
taminhhien 0:1cb528f651d6 52 if (sys_stats.rom_size[i] != 0) {
taminhhien 0:1cb528f651d6 53 printf("ROM%d: Start 0x%" PRIx32 " Size: 0x%" PRIx32 " \r\n", i, sys_stats.rom_start[i], sys_stats.rom_size[i]);
taminhhien 0:1cb528f651d6 54 }
taminhhien 0:1cb528f651d6 55 }
taminhhien 0:1cb528f651d6 56 }
taminhhien 0:1cb528f651d6 57
taminhhien 0:1cb528f651d6 58 ~SystemReport(void)
taminhhien 0:1cb528f651d6 59 {
taminhhien 0:1cb528f651d6 60 free(thread_stats);
taminhhien 0:1cb528f651d6 61 }
taminhhien 0:1cb528f651d6 62
taminhhien 0:1cb528f651d6 63 /**
taminhhien 0:1cb528f651d6 64 * Report on each Mbed OS Platform stats API
taminhhien 0:1cb528f651d6 65 */
taminhhien 0:1cb528f651d6 66 void report_state(void)
taminhhien 0:1cb528f651d6 67 {
taminhhien 0:1cb528f651d6 68 report_cpu_stats();
taminhhien 0:1cb528f651d6 69 report_heap_stats();
taminhhien 0:1cb528f651d6 70 report_thread_stats();
taminhhien 0:1cb528f651d6 71
taminhhien 0:1cb528f651d6 72 // Clear next line to separate subsequent report logs
taminhhien 0:1cb528f651d6 73 printf("\r\n");
taminhhien 0:1cb528f651d6 74 }
taminhhien 0:1cb528f651d6 75
taminhhien 0:1cb528f651d6 76 /**
taminhhien 0:1cb528f651d6 77 * Report CPU idle and awake time in terms of percentage
taminhhien 0:1cb528f651d6 78 */
taminhhien 0:1cb528f651d6 79 void report_cpu_stats(void)
taminhhien 0:1cb528f651d6 80 {
taminhhien 0:1cb528f651d6 81 static uint64_t prev_idle_time = 0;
taminhhien 0:1cb528f651d6 82
taminhhien 0:1cb528f651d6 83 printf("================= CPU STATS =================\r\n");
taminhhien 0:1cb528f651d6 84
taminhhien 0:1cb528f651d6 85 // Collect and print cpu stats
taminhhien 0:1cb528f651d6 86 mbed_stats_cpu_get(&cpu_stats);
taminhhien 0:1cb528f651d6 87
taminhhien 0:1cb528f651d6 88 uint64_t diff = (cpu_stats.idle_time - prev_idle_time);
taminhhien 0:1cb528f651d6 89 uint8_t idle = (diff * 100) / (sample_time_ms * 1000); // usec;
taminhhien 0:1cb528f651d6 90 uint8_t usage = 100 - ((diff * 100) / (sample_time_ms * 1000)); // usec;;
taminhhien 0:1cb528f651d6 91 prev_idle_time = cpu_stats.idle_time;
taminhhien 0:1cb528f651d6 92
taminhhien 0:1cb528f651d6 93 printf("Idle: %d%% Usage: %d%% \r\n", idle, usage);
taminhhien 0:1cb528f651d6 94 }
taminhhien 0:1cb528f651d6 95
taminhhien 0:1cb528f651d6 96 /**
taminhhien 0:1cb528f651d6 97 * Report current heap stats. Current heap refers to the current amount of
taminhhien 0:1cb528f651d6 98 * allocated heap. Max heap refers to the highest amount of heap allocated
taminhhien 0:1cb528f651d6 99 * since reset.
taminhhien 0:1cb528f651d6 100 */
taminhhien 0:1cb528f651d6 101 void report_heap_stats(void)
taminhhien 0:1cb528f651d6 102 {
taminhhien 0:1cb528f651d6 103 printf("================ HEAP STATS =================\r\n");
taminhhien 0:1cb528f651d6 104
taminhhien 0:1cb528f651d6 105 // Collect and print heap stats
taminhhien 0:1cb528f651d6 106 mbed_stats_heap_get(&heap_stats);
taminhhien 0:1cb528f651d6 107
taminhhien 0:1cb528f651d6 108 printf("Current heap: %" PRIu32 "\r\n", heap_stats.current_size);
taminhhien 0:1cb528f651d6 109 printf("Max heap size: %" PRIu32 "\r\n", heap_stats.max_size);
taminhhien 0:1cb528f651d6 110 }
taminhhien 0:1cb528f651d6 111
taminhhien 0:1cb528f651d6 112 /**
taminhhien 0:1cb528f651d6 113 * Report active thread stats
taminhhien 0:1cb528f651d6 114 */
taminhhien 0:1cb528f651d6 115 void report_thread_stats(void)
taminhhien 0:1cb528f651d6 116 {
taminhhien 0:1cb528f651d6 117 printf("================ THREAD STATS ===============\r\n");
taminhhien 0:1cb528f651d6 118
taminhhien 0:1cb528f651d6 119 // Collect and print running thread stats
taminhhien 0:1cb528f651d6 120 int count = mbed_stats_thread_get_each(thread_stats, max_thread_count);
taminhhien 0:1cb528f651d6 121
taminhhien 0:1cb528f651d6 122 for (int i = 0; i < count; i++) {
taminhhien 0:1cb528f651d6 123 printf("ID: 0x%" PRIx32 " \r\n", thread_stats[i].id);
taminhhien 0:1cb528f651d6 124 printf("Name: %s \r\n", thread_stats[i].name);
taminhhien 0:1cb528f651d6 125 printf("State: %" PRIu32 " \r\n", thread_stats[i].state);
taminhhien 0:1cb528f651d6 126 printf("Priority: %" PRIu32 " \r\n", thread_stats[i].priority);
taminhhien 0:1cb528f651d6 127 printf("Stack Size: %" PRIu32 " \r\n", thread_stats[i].stack_size);
taminhhien 0:1cb528f651d6 128 printf("Stack Space: %" PRIu32 " \r\n", thread_stats[i].stack_space);
taminhhien 0:1cb528f651d6 129 }
taminhhien 0:1cb528f651d6 130 }
taminhhien 0:1cb528f651d6 131 };
taminhhien 0:1cb528f651d6 132
taminhhien 0:1cb528f651d6 133 #endif // STATS_REPORT_H