memory-analysis

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Need to understand the Flash/RAM usage of the firmware after build completion.
Need to find the functions or variables that occupy the most space.
Need to compare memory changes between two builds and track code bloat.
Need to confirm whether the firmware is about to exceed the chip memory limit.
Need to parse linker scripts to obtain the total Flash/RAM capacity of the chip.

```
--scan
```
mode automatically searches for .map and ELF files in the build directory.
Parse the
```
Memory Configuration
```
block in the .map file to obtain the total FLASH/RAM capacity.
If a linker script is provided, parse capacity information from the
```
MEMORY {}
```
block.
Automatically detect the availability of
```
arm-none-eabi-size
```
and
```
arm-none-eabi-readelf
```
.

First read references/usage.md to confirm whether this is environment detection, build directory scanning, or execution of analysis.
If unsure whether the tool is available, first run the
```
--detect
```
mode of scripts/memory_analyzer.py to confirm.
Use
```
--scan <build_dir>
```
to automatically find analyzable files.
Use
```
--map-file
```
or
```
--elf
```
to perform memory analysis.
Optionally use
```
--linker-script
```
to obtain total capacity and calculate usage rate.
Use
```
--top <N>
```
to view the symbols that occupy the most space.
Use
```
--compare
```
to compare differences between two .map files.

当

arm-none-eabi-size

或

arm-none-eabi-readelf

不可用且需要 ELF 分析时，返回

environment-missing

。

Return

environment-missing

when

arm-none-eabi-size

arm-none-eabi-readelf

is unavailable and ELF analysis is required.

Return
```
artifact-missing
```
when the specified .map or ELF file does not exist.
Return
```
project-config-error
```
when the .map file format cannot be recognized or parsing fails.
When memory usage exceeds the alarm threshold, attach alarm information to the successful result.

.map file parsing uses pure regular expressions, no external tools required, available on all platforms.
ELF analysis requires
```
arm-none-eabi-size
```
, which is usually installed with the cross-compilation toolchain.
Linker script parsing uses pure regular expressions, supporting GCC LD format.

Output the size and address of each section (.text, .rodata, .data, .bss).
Output Flash usage (.text + .rodata + .data) and RAM usage (.data + .bss).
If total capacity information is available, output usage percentage and alarm status.
Output a sorted list of Top-N symbols by size.
Comparison mode outputs the increase/decrease changes of each section and symbol.

When memory is about to overflow and optimization is needed, it is recommended that users review the Top-N large symbols.
When needing to locate the specific position of a function in the code, it can be used with IDE or
```
grep
```
.