mirror of https://github.com/Telecominfraproject/OpenCellular.git synced 2025-12-29 18:11:05 +00:00

Files

Nicolas Boichat 588320d4b8 stack_analyzer: Use board/$BOARD/analyzestack.yaml by default

BRANCH=none
BUG=chromium:648840
TEST=make BOARD=hammer analyzestack

Change-Id: Id05fee7e085a02dd4c2d36880f6891c3eb86b404
Signed-off-by: Nicolas Boichat <drinkcat@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/637550
Reviewed-by: Che-yu Wu <cheyuw@google.com>
Reviewed-by: Vincent Palatin <vpalatin@chromium.org>

2017-09-07 12:56:29 -07:00

example_annotation.yaml

extra/stack_analyzer: Configurable exception frame size.

2017-09-05 23:01:10 -07:00

README.md

stack_analyzer: Use board/$BOARD/analyzestack.yaml by default

2017-09-07 12:56:29 -07:00

run_tests.sh

presubmit_check: Check unittests results on extra/stack_analyzer

2017-08-29 22:08:20 -07:00

stack_analyzer_unittest.py

stack_analyzer: Use board/$BOARD/analyzestack.yaml by default

2017-09-07 12:56:29 -07:00

stack_analyzer.py

stack_analyzer: Use board/$BOARD/analyzestack.yaml by default

2017-09-07 12:56:29 -07:00

README.md

Stack Size Analysis Tool for EC Firmware

This tool does static analysis on EC firmwares to get the maximum stack usage of each function and task. The maximum stack usage of a function includes the stack used by itself and the functions it calls.

Usage

Make sure the firmware of your target board has been built.

In src/platform/ec, run

make BOARD=${BOARD} SECTION=${SECTION} ANNOTATION=${ANNOTATION} analyzestack

The ${SECTION} can be RO or RW. The ${ANNOTATION} is a optional annotation file, see the example_annotation.yaml, by default, board/$BOARD/analyzestack.yaml is used.

Output

For each task, it will output the result like below,

Task: PD_C1, Max size: 1156 (932 + 224), Allocated size: 640
Call Trace:
    pd_task (160) [common/usb_pd_protocol.c:1644] 1008a6e8
        -> pd_task[common/usb_pd_protocol.c:1808] 1008ac8a
           - handle_request[common/usb_pd_protocol.c:1191]
             - handle_data_request[common/usb_pd_protocol.c:798]
        -> pd_task[common/usb_pd_protocol.c:2672] 1008c222
        -> [annotation]
    pd_send_request_msg.lto_priv.263 (56) [common/usb_pd_protocol.c:653] 1009a0b4
        -> pd_send_request_msg.lto_priv.263[common/usb_pd_protocol.c:712] 1009a22e0

The pd_task uses 160 bytes on the stack and calls pd_send_request_msg.lto_priv.263.

The callsites to the next function will be shown like below,

-> pd_task[common/usb_pd_protocol.c:1808] 1008ac8a
   - handle_request[common/usb_pd_protocol.c:1191]
     - handle_data_request[common/usb_pd_protocol.c:798]
-> pd_task[common/usb_pd_protocol.c:2672] 1008c222
-> [annotation]

This means one callsite to the next function is at usb_pd_protocol.c:798, but it is inlined to the current function and you can follow the trace: usb_pd_protocol.c:1808 -> usb_pd_protocol.c:1191 -> usb_pd_protocol.c:798 to find the callsite. The second callsite is at usb_pd_protocol.c:2672. And the third one is added by annotation.

The unresolved indirect callsites have the similar format to the above.

Annotating Indirect Call

To annotate an indirect call like this,

Unresolved indirect callsites:
    pd_transmit
        -> pd_transmit[common/usb_pd_protocol.c:407] 802c9c8
           - tcpm_transmit[driver/tcpm/tcpm.h:142]

It is an indirect call in the tcpm_transmit, which is inlined to the pd_transmit.

You can add a annotation like the below to eliminate it.

add:
  tcpm_transmit[driver/tcpm/tcpm.h:142]:
  - anx74xx_tcpm_transmit

The source tcpm_transmit[driver/tcpm/tcpm.h:142] must be a full signature (function_name[path:line number]). So the resolver can know which indirect call you want to annotate and eliminate (even if it is inlined).