Add basic stats reporting to blinky. #144
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,24 @@ | ||
| /* mbed Microcontroller Library | ||
| * Copyright (c) 2018 ARM Limited | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| #include "mbed.h" | ||
| #include "stats_report.h" | ||
|
|
||
| DigitalOut led1(LED1); | ||
|
|
||
| // main() runs in its own thread in the OS | ||
| int main() | ||
| { | ||
| SystemReport sys_state(500 /* Loop delay time in ms */); | ||
|
|
||
| while (true) { | ||
| // Blink LED and wait 0.5 seconds | ||
| led1 = !led1; | ||
| wait(0.5f); | ||
|
|
||
| // Following the main thread wait, report on the current system status | ||
| sys_state.report_state(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "target_overrides": { | ||
| "*": { | ||
| "platform.stdio-baud-rate": 115200, | ||
|
There was a problem hiding this comment. We should check with docs team if changing this will require docs change too, as we now need to specify the baud rate in any place where we mention serial. There was a problem hiding this comment. Quick start makes mention of it, but pinging @AnotherButler to double check. |
||
| "platform.stack-stats-enabled": true, | ||
| "platform.heap-stats-enabled": true, | ||
| "platform.cpu-stats-enabled": true, | ||
| "platform.thread-stats-enabled": true, | ||
| "platform.sys-stats-enabled": true | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| /* mbed Microcontroller Library | ||
| * Copyright (c) 2018 ARM Limited | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| #ifndef STATS_REPORT_H | ||
kegilbert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #define STATS_REPORT | ||
|
|
||
| #include "mbed.h" | ||
|
|
||
| /** | ||
| * System Reporting library. Provides runtime information on device: | ||
| * - CPU sleep, idle, and wake times | ||
| * - Heap and stack usage | ||
| * - Thread information | ||
| * - Static system information | ||
| */ | ||
| class SystemReport { | ||
kegilbert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| mbed_stats_heap_t heap_stats; | ||
| mbed_stats_cpu_t cpu_stats; | ||
| mbed_stats_sys_t sys_stats; | ||
|
|
||
| mbed_stats_thread_t *thread_stats; | ||
| uint8_t thread_count; | ||
| uint8_t max_thread_count; | ||
| uint32_t sample_time_ms; | ||
|
|
||
| public: | ||
| /** | ||
| * SystemReport - Sample rate in ms is required to handle the CPU percent awake logic | ||
| */ | ||
| SystemReport(uint32_t sample_rate) : max_thread_count(8), sample_time_ms(sample_rate) | ||
| { | ||
| thread_stats = new mbed_stats_thread_t[max_thread_count]; | ||
|
|
||
| // Collect the static system information | ||
| mbed_stats_sys_get(&sys_stats); | ||
|
|
||
| printf("=============================== SYSTEM INFO ================================\r\n"); | ||
| printf("Mbed OS Version: %ld \r\n", sys_stats.os_version); | ||
| printf("CPU ID: 0x%lx \r\n", sys_stats.cpu_id); | ||
| printf("Compiler ID: %d \r\n", sys_stats.compiler_id); | ||
| printf("Compiler Version: %ld \r\n", sys_stats.compiler_version); | ||
|
|
||
| for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) { | ||
| if (sys_stats.ram_size[i] != 0) { | ||
| printf("RAM%d: Start 0x%lx Size: 0x%lx \r\n", i, sys_stats.ram_start[i], sys_stats.ram_size[i]); | ||
| } | ||
| } | ||
| for (int i = 0; i < MBED_MAX_MEM_REGIONS; i++) { | ||
| if (sys_stats.rom_size[i] != 0) { | ||
| printf("ROM%d: Start 0x%lx Size: 0x%lx \r\n", i, sys_stats.rom_start[i], sys_stats.rom_size[i]); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| ~SystemReport(void) | ||
| { | ||
| free(thread_stats); | ||
| } | ||
|
|
||
| /** | ||
| * Report on each Mbed OS Platform stats API | ||
| */ | ||
| void report_state(void) | ||
| { | ||
| report_cpu_stats(); | ||
| report_heap_stats(); | ||
| report_thread_stats(); | ||
|
|
||
| // Clear next line to separate subsequent report logs | ||
| printf("\r\n"); | ||
| } | ||
|
|
||
| /** | ||
| * Report CPU idle and awake time in terms of percentage | ||
| */ | ||
| void report_cpu_stats(void) | ||
| { | ||
| static uint64_t prev_idle_time = 0; | ||
|
|
||
| printf("================= CPU STATS =================\r\n"); | ||
|
|
||
| // Collect and print cpu stats | ||
| mbed_stats_cpu_get(&cpu_stats); | ||
|
|
||
| uint64_t diff = (cpu_stats.idle_time - prev_idle_time); | ||
| uint8_t idle = (diff * 100) / (sample_time_ms * 1000); // usec; | ||
| uint8_t usage = 100 - ((diff * 100) / (sample_time_ms * 1000)); // usec;; | ||
| prev_idle_time = cpu_stats.idle_time; | ||
|
|
||
| printf("Idle: %d%% Usage: %d%% \r\n", idle, usage); | ||
| } | ||
|
|
||
| /** | ||
| * Report current heap stats. Current heap refers to the current amount of | ||
| * allocated heap. Max heap refers to the highest amount of heap allocated | ||
| * since reset. | ||
| */ | ||
| void report_heap_stats(void) | ||
| { | ||
| printf("================ HEAP STATS =================\r\n"); | ||
|
|
||
| // Collect and print heap stats | ||
| mbed_stats_heap_get(&heap_stats); | ||
|
|
||
| printf("Current heap: %lu\r\n", heap_stats.current_size); | ||
| printf("Max heap size: %lu\r\n", heap_stats.max_size); | ||
| } | ||
|
|
||
| /** | ||
| * Report active thread stats | ||
| */ | ||
| void report_thread_stats(void) | ||
| { | ||
| printf("================ THREAD STATS ===============\r\n"); | ||
|
|
||
| // Collect and print running thread stats | ||
| int count = mbed_stats_thread_get_each(thread_stats, max_thread_count); | ||
|
|
||
| for (int i = 0; i < count; i++) { | ||
| printf("ID: 0x%lx \r\n", thread_stats[i].id); | ||
| printf("Name: %s \r\n", thread_stats[i].name); | ||
| printf("State: %ld \r\n", thread_stats[i].state); | ||
| printf("Priority: %ld \r\n", thread_stats[i].priority); | ||
| printf("Stack Size: %ld \r\n", thread_stats[i].stack_size); | ||
| printf("Stack Space: %ld \r\n", thread_stats[i].stack_space); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| #endif // STATS_REPORT_H | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kegilbert - Maybe we can point to other stats examples as well - https://github.com/ARMmbed/mbed-os-example-cpu-stats
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The stats API link has examples on that page inline that are pulled from the teams repo which is copied from the github repo (quite the path...). I can add the github links as well if we'd like a direct link to the Github hosted examples (the docs site does lose the README info).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the stats API link has the links already we ca skip adding them here.