Natasha Sarkar / Mbed OS m119_a2_p4

ECEM119 assignment 2 problem 4

stats_report.h@0:44f80f935e35, 2019-04-17 (annotated)

Committer:
natasha41575
Date:
Wed Apr 17 21:40:16 2019 +0000
Revision:
0:44f80f935e35
P2

Who changed what in which revision?

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