From 753f61edc9b9882455d5aeac4dcd5f2394bb9460 Mon Sep 17 00:00:00 2001
From: Radoslaw Koppel <radoslaw.koppel@nordicsemi.no>
Date: Tue, 30 Jan 2024 12:32:32 +0100
Subject: [PATCH] buildsystem: Add an option to enable LTO
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit adds option to enable Link Time Optimization.

Signed-off-by: Radosław Koppel <radoslaw.koppel@nordicsemi.no>
---
 CMakeLists.txt                          | 9 +++++++++
 Kconfig.zephyr                          | 7 +++++++
 cmake/bintools/gnu/target.cmake         | 9 +++++++--
 cmake/compiler/gcc/compiler_flags.cmake | 3 +++
 cmake/linker/ld/linker_flags.cmake      | 2 ++
 5 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index a1876013aa9605..f1fb89660f9c7c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -213,6 +213,11 @@ endif()
 # Apply the final optimization flag(s)
 zephyr_compile_options(${OPTIMIZATION_FLAG})
 
+if(CONFIG_LTO)
+  add_compile_options($<TARGET_PROPERTY:compiler,optimization_lto>)
+  add_link_options($<TARGET_PROPERTY:linker,lto_arguments>)
+endif()
+
 # @Intent: Obtain compiler specific flags related to C++ that are not influenced by kconfig
 zephyr_compile_options($<$<COMPILE_LANGUAGE:CXX>:$<TARGET_PROPERTY:compiler-cpp,required>>)
 
@@ -805,6 +810,10 @@ target_include_directories(${OFFSETS_LIB} PRIVATE
   kernel/include
   ${ARCH_DIR}/${ARCH}/include
   )
+
+# Make sure that LTO will never be enabled when compiling offsets.c
+set_source_files_properties(${OFFSETS_C_PATH} PROPERTIES COMPILE_OPTIONS $<TARGET_PROPERTY:compiler,prohibit_lto>)
+
 target_link_libraries(${OFFSETS_LIB} zephyr_interface)
 add_dependencies(zephyr_interface
   ${SYSCALL_LIST_H_TARGET}
diff --git a/Kconfig.zephyr b/Kconfig.zephyr
index c384c8053f9fb5..829deac2a9c549 100644
--- a/Kconfig.zephyr
+++ b/Kconfig.zephyr
@@ -428,6 +428,13 @@ config NO_OPTIMIZATIONS
 	  default stack sizes in order to avoid stack overflows.
 endchoice
 
+config LTO
+	bool "Link Time Optimization [EXPERIMENTAL]"
+	depends on !(GEN_ISR_TABLES || GEN_IRQ_VECTOR_TABLE) || ISR_TABLES_LOCAL_DECLARATION
+	select EXPERIMENTAL
+	help
+	  This option enables Link Time Optimization.
+
 config COMPILER_WARNINGS_AS_ERRORS
 	bool "Treat warnings as errors"
 	help
diff --git a/cmake/bintools/gnu/target.cmake b/cmake/bintools/gnu/target.cmake
index 86c66b4825ce4d..612f6de79b29b6 100644
--- a/cmake/bintools/gnu/target.cmake
+++ b/cmake/bintools/gnu/target.cmake
@@ -5,8 +5,13 @@
 find_program(CMAKE_OBJCOPY ${CROSS_COMPILE}objcopy PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
 find_program(CMAKE_OBJDUMP ${CROSS_COMPILE}objdump PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
 find_program(CMAKE_AS      ${CROSS_COMPILE}as      PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
-find_program(CMAKE_AR      ${CROSS_COMPILE}ar      PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
-find_program(CMAKE_RANLIB  ${CROSS_COMPILE}ranlib  PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
+if(CONFIG_LTO)
+  find_program(CMAKE_AR      ${CROSS_COMPILE}gcc-ar      PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
+  find_program(CMAKE_RANLIB  ${CROSS_COMPILE}gcc-ranlib  PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
+else()
+  find_program(CMAKE_AR      ${CROSS_COMPILE}ar      PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
+  find_program(CMAKE_RANLIB  ${CROSS_COMPILE}ranlib  PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
+endif()
 find_program(CMAKE_READELF ${CROSS_COMPILE}readelf PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
 find_program(CMAKE_NM      ${CROSS_COMPILE}nm      PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
 find_program(CMAKE_STRIP   ${CROSS_COMPILE}strip   PATHS ${TOOLCHAIN_HOME} NO_DEFAULT_PATH)
diff --git a/cmake/compiler/gcc/compiler_flags.cmake b/cmake/compiler/gcc/compiler_flags.cmake
index db2520771015a6..5867392c3076be 100644
--- a/cmake/compiler/gcc/compiler_flags.cmake
+++ b/cmake/compiler/gcc/compiler_flags.cmake
@@ -21,6 +21,9 @@ endif()
 set_compiler_property(PROPERTY optimization_speed -O2)
 set_compiler_property(PROPERTY optimization_size  -Os)
 
+set_compiler_property(PROPERTY optimization_lto -flto)
+set_compiler_property(PROPERTY prohibit_lto -fno-lto)
+
 #######################################################
 # This section covers flags related to warning levels #
 #######################################################
diff --git a/cmake/linker/ld/linker_flags.cmake b/cmake/linker/ld/linker_flags.cmake
index 8209f4dfbdc457..5660b410760202 100644
--- a/cmake/linker/ld/linker_flags.cmake
+++ b/cmake/linker/ld/linker_flags.cmake
@@ -12,6 +12,8 @@ endif()
 
 set_property(TARGET linker PROPERTY partial_linking "-r")
 
+set_property(TARGET linker PROPERTY lto_arguments -flto -fno-ipa-sra -ffunction-sections -fdata-sections)
+
 # Some linker flags might not be purely ld specific, but a combination of
 # linker and compiler, such as:
 # --coverage for clang