michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/cmake/reports/CMakeLists.txt

121 lines
3 KiB
Text
Raw Permalink Normal View History

license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 09:08:09 -04:00
# SPDX-License-Identifier: Apache-2.0
scripts: size_report: rework to use pyelftools... ...instead of GNU binutils to extract DWARF information. This is now a bit more portable across OS and toolchain. One bouns is that this nows with on qemu_x86_64. A few differences are: () z_mrsh_* which are aliases to handler_no_syscalls() are now dropped as they are mapped to the same address, so that they are not counted multiple times. () Static functions and variables with same names should now be attributed to the correct source files instead of being accumulated into the same symbol of one file (e.g. multiple thread_entry() in kernel tests). () The totals for ROM and RAM are calculated from the corresponding sections. Previous script includes the debug sections as total ROM size which is not entirely correct. Fixes #22996 Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2020-07-10 14:32:33 -07:00
set(flag_for_ram_report ram)
set(flag_for_rom_report rom)
reports: footprint: Print footprint output Both ram and rom reports print their outputs in the console and publish their reports in json. footprint is wrapper to generate both reports but it is currently not printing their outputs in the console nor given any feedback to the user that those reports were generated. Change it to behave like the others reports allowing the user to see them and / or redirect to a file if they want. Signed-off-by: Flavio Ceolin <flavio.ceolin@gmail.com>
2024-10-21 11:01:15 -07:00
set(flag_for_footprint all)
scripts: size_report: Add a depth parameter to CMakeLists.txt The parameter can be used to limit the ram and rom reports to a certain depth. The resulting graphs with depths of e.g. 3 or 4 are visually easier to grasp. Signed-off-by: Detlev Zundel <dzu@member.fsf.org>
2021-02-25 09:22:26 +01:00
set(report_depth 99)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
scripts: size_report: add tree node for WORKSPACE Add a tree node to group files under WORKSPACE so that they won't be shown with full path. The WORKSPACE is usually the same as WEST_TOPDIR unless ZEPHYR_WORKSPACE is defined during build. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-05-25 11:16:34 -07:00
if(DEFINED ZEPHYR_WORKSPACE)
set(workspace_arg "--workspace=${ZEPHYR_WORKSPACE}")
elseif(DEFINED WEST_TOPDIR)
set(workspace_arg "--workspace=${WEST_TOPDIR}")
endif()
cmake: reports: Fix report targets Fixes report targets where tfm_* and bl2_* targets wrongly generates a footprint file by having a common target which consists of RAM and ROM report targets Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 10:45:00 +00:00
foreach(report ram_report rom_report)
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
add_custom_target(
${report}
${PYTHON_EXECUTABLE}
cmake: Use path-corrected version of ZEPHYR_BASE Instead of accessing the environment variable ZEPHYR_BASE every time we require accessing the source code root, use an intermediate variable that has OS path separators correctly set to '/' to avoid issues on Windows. Note: This removes the ZEPHYR_SOURCE_DIR CMake variable. External applications using that will need to change to use the new ZEPHYR_BASE variable. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-01-11 15:46:44 +01:00
${ZEPHYR_BASE}/scripts/footprint/size_report
scripts: size_report: rework to use pyelftools... ...instead of GNU binutils to extract DWARF information. This is now a bit more portable across OS and toolchain. One bouns is that this nows with on qemu_x86_64. A few differences are: () z_mrsh_* which are aliases to handler_no_syscalls() are now dropped as they are mapped to the same address, so that they are not counted multiple times. () Static functions and variables with same names should now be attributed to the correct source files instead of being accumulated into the same symbol of one file (e.g. multiple thread_entry() in kernel tests). () The totals for ROM and RAM are calculated from the corresponding sections. Previous script includes the debug sections as total ROM size which is not entirely correct. Fixes #22996 Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2020-07-10 14:32:33 -07:00
-k ${ZEPHYR_BINARY_DIR}/${KERNEL_ELF_NAME}
-z ${ZEPHYR_BASE}
-o ${CMAKE_BINARY_DIR}
scripts: size_report: add tree node for WORKSPACE Add a tree node to group files under WORKSPACE so that they won't be shown with full path. The WORKSPACE is usually the same as WEST_TOPDIR unless ZEPHYR_WORKSPACE is defined during build. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-05-25 11:16:34 -07:00
${workspace_arg}
scripts: size_report: Add a depth parameter to CMakeLists.txt The parameter can be used to limit the ram and rom reports to a certain depth. The resulting graphs with depths of e.g. 3 or 4 are visually easier to grasp. Signed-off-by: Detlev Zundel <dzu@member.fsf.org>
2021-02-25 09:22:26 +01:00
-d ${report_depth}
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
${flag_for_${report}}
DEPENDS ${logical_target_for_zephyr_elf}
cmake: allow appending dependencies to report targets To facilitate extending the generated reports without having to patch this file, leverage generator-expression so that dependencies can be added to the 'zephyr_property_target' target. Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
2020-01-17 14:03:11 +00:00
$<TARGET_PROPERTY:zephyr_property_target,${report}_DEPENDENCIES>
scripts: size_report: Fix colorized output Colorama needs to be initialized, and for colors to display correctly on Windows one needs to use the `USES_TERMINAL` option in CMake. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2020-09-02 21:28:34 +02:00
USES_TERMINAL
build: reports: publish all reports Publish all reports in json format. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-06-07 07:59:02 -04:00
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
Introduce cmake-based rewrite of KBuild Introducing CMake is an important step in a larger effort to make Zephyr easy to use for application developers working on different platforms with different development environment needs. Simplified, this change retains Kconfig as-is, and replaces all Makefiles with CMakeLists.txt. The DSL-like Make language that KBuild offers is replaced by a set of CMake extentions. These extentions have either provided simple one-to-one translations of KBuild features or introduced new concepts that replace KBuild concepts. This is a breaking change for existing test infrastructure and build scripts that are maintained out-of-tree. But for FW itself, no porting should be necessary. For users that just want to continue their work with minimal disruption the following should suffice: Install CMake 3.8.2+ Port any out-of-tree Makefiles to CMake. Learn the absolute minimum about the new command line interface: $ cd samples/hello_world $ mkdir build && cd build $ cmake -DBOARD=nrf52_pca10040 .. $ cd build $ make PR: zephyrproject-rtos#4692 docs: http://docs.zephyrproject.org/getting_started/getting_started.html Signed-off-by: Sebastian Boe <sebastian.boe@nordicsemi.no>
2017-10-27 15:43:34 +02:00
)
endforeach()
build: reports: add puncover target puncover is a footprint and stack analysis tool in python, see https://github.com/HBehrens/puncover Add custom target puncover which launches puncover with the right options. Launch for example with: west build -b frdm_k64f samples/hello_world/ -t puncover Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-05-04 07:53:00 -04:00
cmake: reports: Fix report targets Fixes report targets where tfm_* and bl2_* targets wrongly generates a footprint file by having a common target which consists of RAM and ROM report targets Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 10:45:00 +00:00
add_custom_target(
footprint
DEPENDS ram_report rom_report
)
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
if(CONFIG_BUILD_WITH_TFM)
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
foreach(report ram rom)
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
add_custom_target(
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
tfm_${report}_report
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
${PYTHON_EXECUTABLE}
${ZEPHYR_BASE}/scripts/footprint/size_report
-k $<TARGET_PROPERTY:tfm,TFM_S_ELF_FILE>
-z ${ZEPHYR_BASE}
-o ${CMAKE_BINARY_DIR}
${workspace_arg}
-d ${report_depth}
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
--json tfm_${report}.json
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
${flag_for_${report}_report}
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
DEPENDS tfm
USES_TERMINAL
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)
endforeach()
cmake: reports: Fix report targets Fixes report targets where tfm_* and bl2_* targets wrongly generates a footprint file by having a common target which consists of RAM and ROM report targets Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 10:45:00 +00:00
add_custom_target(
tfm_footprint
DEPENDS tfm_ram_report tfm_rom_report
)
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
endif()
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
if(CONFIG_TFM_BL2)
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
foreach(report ram rom)
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
add_custom_target(
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
bl2_${report}_report
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
${PYTHON_EXECUTABLE}
${ZEPHYR_BASE}/scripts/footprint/size_report
-k $<TARGET_PROPERTY:tfm,BL2_ELF_FILE>
-z ${ZEPHYR_BASE}
-o ${CMAKE_BINARY_DIR}
${workspace_arg}
-d ${report_depth}
--json bl2_${report}.json
cmake: reports: Fix file prefix for tfm/bl2 Fixes the prefix for these files to not have _report in them Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 11:38:06 +00:00
${flag_for_${report}_report}
cmake: reports: Add support for JSON prefix Adds support for prefixing files with the target of bl2 or tfm Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 12:33:13 +00:00
DEPENDS tfm
USES_TERMINAL
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
)
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
endforeach()
cmake: reports: Fix report targets Fixes report targets where tfm_* and bl2_* targets wrongly generates a footprint file by having a common target which consists of RAM and ROM report targets Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-20 10:45:00 +00:00
add_custom_target(
bl2_footprint
DEPENDS bl2_ram_report bl2_rom_report
)
scripts: size_report: Add support for TF-M and BL2 image size reports Add support for TF-M and BL2 image size reports. This adds the following targets when TF-M or BL2 is enabled: tfm_rom_report, tfm_ram_report, tfm_footprint bl2_rom_report, bl2_ram_report, bl2_footprint Example: west build -t tfm_rom_report Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
2022-03-03 13:25:13 +01:00
endif()
build: reports: add puncover target puncover is a footprint and stack analysis tool in python, see https://github.com/HBehrens/puncover Add custom target puncover which launches puncover with the right options. Launch for example with: west build -b frdm_k64f samples/hello_world/ -t puncover Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-05-04 07:53:00 -04:00
find_program(PUNCOVER puncover)
if(NOT ${PUNCOVER} STREQUAL PUNCOVER-NOTFOUND)
add_custom_target(
puncover
${PUNCOVER}
--elf_file ${ZEPHYR_BINARY_DIR}/${KERNEL_ELF_NAME}
--gcc_tools_base ${CROSS_COMPILE}
--src_root ${ZEPHYR_BASE}
--build_dir ${CMAKE_BINARY_DIR}
DEPENDS ${logical_target_for_zephyr_elf}
$<TARGET_PROPERTY:zephyr_property_target,${report}_DEPENDENCIES>
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
USES_TERMINAL
)
endif()
build: reports: add pahole target Poke-a-hole (pahole) is an object-file analysis tool to find the size of the data structures, and the holes caused due to aligning the data elements to the word-size of the CPU by the compiler. http://git.kernel.org/cgit/devel/pahole/pahole.git Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2020-07-08 18:53:24 +02:00
find_program(PAHOLE pahole)
if(NOT ${PAHOLE} STREQUAL PAHOLE-NOTFOUND)
add_custom_target(
pahole
${PAHOLE}
--anon_include
--nested_anon_include
--show_decl_info
$<$<BOOL:${CMAKE_VERBOSE_MAKEFILE}>:--verbose>
${ZEPHYR_BINARY_DIR}/${KERNEL_ELF_NAME}
DEPENDS ${logical_target_for_zephyr_elf}
$<TARGET_PROPERTY:zephyr_property_target,${report}_DEPENDENCIES>
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
USES_TERMINAL
)
endif()
Copy permalink