Oliver Ainhirn / Mbed OS 81_Thread_02

version2

stats_report.h@1:f17f1b284f68, 2019-03-14 (annotated)

Committer:
corsa1600
Date:
Thu Mar 14 18:32:08 2019 +0000
Revision:
1:f17f1b284f68
Parent:
0:300fb6f45ac9 
version2

Who changed what in which revision?

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