Fa Cake / Mbed OS mbed-os-example-blinky

my

Dependencies:   QEI BNO055 ros_lib_kinetic

stats_report.h@0:ae2e2cabc497, 2019-08-01 (annotated)

Committer:
fllay
Date:
Thu Aug 01 17:10:38 2019 +0000
Revision:
0:ae2e2cabc497
fa

Who changed what in which revision?

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