Dheeraj Kamath / Mbed OS BlinkyUart

Toggles LED and prints debug information

stats_report.h@3:a773d045cb0d, 2019-05-26 (annotated)

Committer:
Dheeraj22
Date:
Sun May 26 17:20:23 2019 +0000
Revision:
3:a773d045cb0d
Parent:
0:19ea743b1bfa 
Baud rate changed to 9600.

Who changed what in which revision?

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