DANTE EICKHOFF / Mbed OS mbed-os-example-blinky

xx

stats_report.h@0:5aa0f12e7698, 2018-12-09 (annotated)

Committer:
danteeickhoff
Date:
Sun Dec 09 22:34:28 2018 +0000
Revision:
0:5aa0f12e7698
xx

Who changed what in which revision?

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